Sphinx (générateur de documentation)

Sphinx
Informations
Développé par Georg Brandl
Première version
Dernière version 8.2.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

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

  1. « Release 8.2.3 », (consulté le )

Voir aussi

Articles connexes

Liens externes

  • icône décorative Portail des logiciels libres
  • icône décorative Portail de l’informatique
  • icône décorative Portail du logiciel