Générer la documentation avec SphinxDocs

Vous pouvez générer de la documentation à partir du code en utilisant Sphinx.

Pour ce faire, vous devez d'abord installer Sphinx à l'aide de la commande suivante :

pip install -U sphinx

Ensuite, allez dans le répertoire sphinx_docs en faisant :

cd sphinx_docs/

Vous pouvez maintenant générer la documentation comme suit :

make html

Si vous souhaitez nettoyer le répertoire build, vous pouvez utiliser cette commande :

make clean

La documentation a maintenant été générée. Pour l'ouvrir, allez dans le répertoire build, puis dans le répertoire html. Double-cliquez sur le fichier index.html pour l'ouvrir. Sinon, faites un clic droit et cliquez sur ouvrir avec et choisissez un navigateur pour l'ouvrir.