Skip to content
Snippets Groups Projects

Building docs

We use Sphinx for generating the API and reference documentation.

Instructions

Install the following Python packages needed to build the documentation by entering:

pip install sphinx sphinx-autodoc-typehints sphinx-rtd-theme

To build the HTML documentation, enter::

make html

in the doc/ directory. This will generate a build/html subdirectory containing the built documentation.

To build the PDF documentation, enter::

make latexpdf

You will need to have LaTeX installed for this.