Generating Documentation

The documentation is generated from reStructured Text by Sphinx (via Read The Docs). If you’re unfamiliar with reStructured Text, the files typically have the extension .rst. You can find more details in the reStructured Text Basics.

Installation instructions

To install the sphinx tools, you’ll need python (and pip) installed.:

.. code-block: shell
pip install –user -r requirements.txt

Generating documentation locally

You can generate the documentation locally with the following command:

This will create documentation in the _build directory which you can open with your browser.

Note that you do not need to add these files to your git client, as Read The Docs will generate the HTML on the fly.