ImperialCollegeLondon / python-template

A template for Python projects using cookiecutter

BSD 3-Clause "New" or "Revised" License

4 stars 1 forks source link

Ignore docs when running pytest #146

Closed AdrianDAlessandro closed 2 weeks ago

AdrianDAlessandro commented 2 weeks ago

Description

Pytest checks the docs folder when looking for tests, this runs gen_ref_nav.py and create the API reference files, which should be avoided.

Fixes #145

Type of change

[ ] Documentation (non-breaking change that adds or improves the documentation)
[ ] New feature (non-breaking change which adds functionality)
[ ] Optimization (non-breaking, back-end change that speeds up the code)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] Breaking change (whatever its nature)

Key checklist

[ ] All tests pass (eg. python -m pytest)
[ ] The documentation builds and looks OK (eg. python -m sphinx -b html docs docs/build)
[ ] Pre-commit hooks run successfully (eg. pre-commit run --all-files)

Further checks

[ ] Code is commented, particularly in hard-to-understand areas
[ ] Tests added or an issue has been opened to tackle that in the future. (Indicate issue here: # (issue))