1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
|
# Simple makefile to simplify repetitive build env management tasks under posix
# Directories to run style checks against
CODE_DIRS ?= doc examples examples_trame pyvista tests
# Files in top level directory
CODE_FILES ?= *.py *.rst *.md
# must be off screen to avoid plotting everything
doctest-modules: export PYVISTA_OFF_SCREEN = True
doctest-modules-local-namespace: export PYVISTA_OFF_SCREEN = True
doctest-modules:
@echo "Running module doctesting"
pytest -v --doctest-modules pyvista
doctest-modules-local-namespace:
@echo "Running module doctesting using docstring local namespace"
python tests/check_doctest_names.py
coverage:
@echo "Running coverage"
@pytest -v --cov pyvista
coverage-xml:
@echo "Reporting XML coverage"
@pytest -v --cov pyvista --cov-report xml
coverage-html:
@echo "Reporting HTML coverage"
@pytest -v --cov pyvista --cov-report html
coverage-docs:
@echo "Reporting documentation coverage"
@make -C doc html SPHINXOPTS="-Q" -b coverage
@cat doc/_build/coverage/python.txt
# Install vale first with `pip install vale`
docstyle:
@echo "Running vale"
@vale --config doc/.vale.ini doc pyvista examples ./*.rst --glob='!*{_build,AUTHORS.rst,_autosummary,source/examples}*'
|