Sphinx (générateur de documentation)
Pour les articles homonymes, voir Sphinx.
Cet article ou cette section d'article est rédigé entièrement ou presque entièrement à partir d'une seule source ().
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.
| Développé par | Georg Brandl |
|---|---|
| Première version | |
| Dernière version | 8.1.3 ()[1] |
| 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.
Caractéristiques
[modifier | modifier le code]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.
Notes et références
[modifier | modifier le code]- « Release 8.1.3 », (consulté le )
Voir aussi
[modifier | modifier le code]Articles connexes
[modifier | modifier le code]Liens externes
[modifier | modifier le code]- (en) Site officiel
