wikinotes

On active l'environnement virtuel du projet et on installe les modules via pip3

cd my_app
source app_env/bin/activate
pip3 install sphinx sphinx_rtd_theme

Le script sphinx-quickstart assiste l'utilisateur pour la création de l'arborescence de base de la documentation et son intégration au sein du projet.

sphinx-quickstart

Ici on fait le choix de créer un répertoire docs à la racine du projet et de produire la documentation technique dans ce répertoire.

• https://towardsdatascience.com/documenting-python-code-with-sphinx-554e1d6c4f6d?gi=d2b08f5fbc51
• https://www.sphinx-doc.org/en/master/