6. Documentation avec Sphinx#
Une documentation bien rédigée aide les utilisateurs et les développeurs à comprendre et à utiliser efficacement votre projet. Sphinx pour générer de la documentation à partir de docstrings.
Maintenez la documentation à jour avec le code. Utilisez des exemples de code pour illustrer l’utilisation des fonctions et des classes
pip install sphinx
sphinx-quickstart docs # Initializes a new documentation in the docs folder
Configurer Sphinx : Ajouter le chemin d’accès à la source et activer les extensions nécessaires dans conf.py.
# docs/conf.py
import os
import sys
sys.path.insert(0, os.path.abspath('../src'))
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon']
Générer la documentation
sphinx-apidoc -o docs/source src
sphinx-build -b html docs/source docs/build
