6. Documentation

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

6.1. Génération du site web de documentation

Pour la génération:

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

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

6.2. Ecrire la documentation avec un rendu en direct

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

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