Documenting the projectΒΆ

Sphinx: automatic generation of documents from docstrings

This documentation has been generated using Sphinx.

In order to generate HTML docs locally, go to doc/ and run:

(python-env) make html

Editting docs

Just edit .rst files.

Generate the documentation on line in readthedocs

  1. log in into readthedocs account
  2. go to project
  3. build