Documentation

Sphinx est utilisé pour la génération de la documentation depuis des pages écrites en Markdown (via le parser MyST).

Génération du site web de documentation

Pour la génération:

# install base dependencies
python -m pip install -U -r requirements/base.txt
# install aditionnal dependencies
python -m pip install -U -r requirements/documentation.txt
# build it
sphinx-build -b html docs docs/_build
# optimized (quiet, multiprocessing, doctrees separated)
sphinx-build -b html -d docs/_build/cache -j auto -q docs docs/_build/html

Ouvrir docs/_build/index.html dans un navigateur web.

Ecrire la documentation avec un rendu en direct

sphinx-autobuild -b html -d docs/_build/cache docs/ docs/_build

Ouvrir http://localhost:8000 dans un navigateur web pour voir le rendu HTML mis à jour quand un fichier est sauvegardé.