mabuchilab / QNET

Computer algebra package for quantum mechanics and photonic quantum networks
https://qnet.readthedocs.io/
MIT License
71 stars 23 forks source link

Automatically run all examples in documentation as doctests #61

Closed goerz closed 6 years ago

goerz commented 6 years ago

All "doctest examples" in the handwritten parts of the documentation (the .rst files in ./docs) should be run automatically by the test suite. This is mostly to guarantee that the documentation is up to date with the latest version of the code. Currently, significant parts of the documentation are not* up to date, so those examples will need to be fixed first.

Note that code examples in docstrings (i.e. the API documentation) are already automatically tested.

goerz commented 6 years ago

Created feature/rstdoctest branch to track this