Documentation uses Sphinx.


Don’t use docstrings for documenting classes, or methods which are already documented in the official documentation. Do use docstrings for documenting functions not present in the official documentation.

Editing the docs

  1. Install requirements (watchdog and sphinx):

    pip install -r requirements/docs.txt
  2. Compile the docs:

    make docs

You can then open the compiled HTML docs in your browser. You will need to compile whenever you make changes to the .rst files.

  1. Edit the doc files.

Read more about reStructuredText syntax.