Sphinx (générateur de documentation)

Informations
Développé par	Georg Brandl
Première version	21 mars 2008
Dernière version	7.3.7 (19 avril 2024)
Dépôt	github.com/sphinx-doc/sphinx
État du projet	En développement
Écrit en	Python
Environnement	Multiplate-forme
Formats lus	ReStructuredText
Type	Générateur de documentation
Politique de distribution	Gratuit
Licence	BSD
Site web	(en) Site officiel

Sphinx est un générateur de documentation libre. Il a été développé par Georg Brandl pour la communauté Python en 2008, et est le générateur de la documentation officielle de projets tels que Python, Django, Selenium, Urwid, ou encore Qpdf, Bazaar, etc.

Si ce bandeau n'est plus pertinent, retirez-le. Cliquez ici pour en savoir plus.

Cet article ou cette section d'article est rédigé entièrement ou presque entièrement à partir d'une seule source (mars 2024).

N'hésitez pas à modifier cet article pour améliorer sa vérifiabilité en apportant de nouvelles références dans des notes de bas de page.

Caractéristiques

Il s'appuie sur des fichiers au format reStructuredText, qu'il convertit, entre autres, en HTML, PDF, EPUB, ou man.

Il supporte, entre autres, l'autogénération à partir du code source ou l'intégration de formules mathématiques.

Il supporte aussi l'auto-exécution de tests intégrés dans la documentation.