This document describes the Sussie application (1.7). For the project page, go here.

3.2. How to build the documentation

3.2.1. Requirements

The documentation is built using sphinx, so you need to have it:

  • pip install sphinx sphinx-autobuild

3.2.2. First-time creation of documentation template

Just once for each project, you can create the documentation template as follows:

  • mkdir docs

  • cd docs

  • sphinx-quickstart

3.2.3. Generate the documentation

To create the html:

  • make html

To create the pdf, you first need to install a latex distribution, then:

  • make latexpdf