Skip to content
Snippets Groups Projects
Yifan Zhao's avatar
Yifan Zhao authored
1b418b04
History

Building docs

We use Sphinx for generating the API and reference documentation.

Instructions

Install Sphinx needed to build the documentation by entering:

pip3 install -r requirements.txt

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.