Sphinx documentation

This documentation is generated using Sphinx, and automatically deployed to github pages

How-to build

Important

You need to be on a linux system with docker installed

cd docs_src && ./build.sh

How-to edit

You can also build the documentation in dev mode with

cd docs_src && ./build.sh --dev

In this mode, the documentation is served on localhost:8000, and automatically updated when you make a change to the sources