Sphinx, outil Python de génération de documentation

Sphinx, outil Python de génération de documentation

Par Gael Pasgrimaud
Date : samedi 3 octobre 2009 11h55
Durée : 20 minutes
Langue : Français
Tags : documentation python

---

Sphinx est l'outil utilisé par python pour générer sa documentation officielle.

Il utilise de simple fichiers texte au format rest pour générer une documentation au format html.

Il permets aussi d'utiliser le code source python pour agrémenter la documentation d'un projet.

Bien qu'étant très lié à python, il peut être utilisé pour documenter n'importe quel projet.

Dans la foulée, je présenterais brièvement MercurialApp. Un projet naissant visant à rendre accessible via le web à la fois un dépot mercurial et sa documentation sphinx.

---

Présentation suivie par: John Lejeune (‎Nightlybuild‎), Patrick Augé (‎harlie‎), Vincent Férotin (‎fero14041‎), Sébastien Aperghis-Tramoni (‎maddingue‎),