Durant la conférence PyCon France 2025, Françoise Conil a présenté Sphinx. Sphinx est un des outils phares pour créer la documentation de son projet. La session s'est focalisée naturellement sur Python. L'un des avantages de Sphinx est sa souplesse : différent format de sortie, Markdown, reStructuredText, une communauté active. La 1ere version remonte à 2008.

Son installation est simple : pip install sphinx. Françoise Conil conseille de l'utiliser en environnement venv ou uv. Il faut tout d'abord configurer et générer la structure documentaire (commande quickstart) puis séparer documentation et sources (--sep). La documentation est structurée : elle contient un fichier conf.py, un fichier racine puis le make/makefile pour générer la doc. Il est possible de créer une table des matières et les liens entre les documents : toctree. Il est possible d'avoir plusieurs niveaux de profondeur. 

Naturellement, on peut intégrer à la documentation Sphinx, la documentation PyDoc. 

Voir la présentation (slides) : https://perso.liris.cnrs.fr/francoise.conil/documenter-avec-sphinx_pyconfr-2025/#/title-slide

Autre prise en main : https://blog.flozz.fr/2020/10/04/documenter-un-projet-python-avec-sphinx/