Meta-docs (docs about the docs)¶
These docs are generated using sphinx
All code in the documentation doubles as doctests, so it is guaranteed to run correctly. In addition, since the API docs (API) include docstrings from the source code itself, these tests are run as well when the documentation is generated.
Building the docs¶
Install the requirements from the
dev-requirements.txtfile in the top dir of the repo:
$ pip install -r dev-requirements.txt
Navigate to the
docfolder in the source.
$ make doctest
Build HTML. The results are in
$ make html