Documentation
This project documentation is generated using
Sphinx
and
numpydoc.
The numpydoc formatting style as documented in the
style guide
is used. See the
example in
the numpydoc documentation on how to properly document the code.
The theme being used is Read the Docs Sphinx Theme.
To generate the documentation (in HTML format, see doc/Makefile
for other formats), execute:
cd docs
make html