Skip to content

Latest commit

 

History

History
25 lines (19 loc) · 399 Bytes

DOCUMENTATION.md

File metadata and controls

25 lines (19 loc) · 399 Bytes

Documentation

Development instructions

Documentation can be automatically generated with Sphinx.

Make sure the dependencies are installed:

pip install -r dev_requirements.txt

Afterwards, compile the documentation in the preferred format:

cd docs_source/
sh generate_modules_rst.sh
# html
make html
# latex
make latex
make latexpdf
# GitHub pages
make github