Documentation

The documentation is built using Sphinx and hosted on ReadTheDocs.

Documentation sources are located in the docs directory. The files are in reStructuredText format.

Local build

To test a local build of the documentation :

  1. Go to the docs directory:

    cd docs
    
  2. Build the documentation:

    make html
    
  3. Open the _build/html/index.html file in your browser.