Skip to content
  • Français: Cette page n'est pas encore traduite en français.

Update documentation

We use mkdocs to maintain our documentation.

Documentation editing

To edit the documentation, first install the same mkdocs version that readthedocs will use during automatic building.

cd documentation
# Activate your virtual environment
# Or create it using `python -m venv env`
source env/bin/activate
# Install dependencies
pip install -r requirements.txt

Then run:

mkdocs serve

The documentation will be available locally at http://127.0.0.1:8000 with live reloading as you edit the documentation.

Documentation building

The build is handled by ReadTheDocs.

You must be added as a maintainer on readthedocs in order to view the project and launch the build and publication.

Two versions of the documentation are published:

  • Develop: binded to the develop branch
  • Latest: binded to the master branch