Sphinx est un outil qui permet de créer facilement des documents intelligente et belle pour les projets Python (ou autres documents constitués de plusieurs sources de reStructuredText), écrit par Georg Brandl. Le projet a été créé à l'origine pour traduire la nouvelle documentation de Python, mais a été nettoyé dans l'espoir qu'il sera utile à de nombreux autres projets.
Sphinx utilise reStructuredText que son langage de balisage, et nombre de ses points forts viennent de la puissance et la simplicité des reStructuredText et son analyse et suite traduire, les Docutils.
Même se il est encore en évolution constante, les caractéristiques suivantes sont déjà présents, fonctionnent très bien et peuvent être vus «en action» dans la documentation de Python:
& Nbsp; * Les formats de sortie: HTML (y compris Windows HTML Help) et LaTeX, pour les versions imprimables PDF
& Nbsp; * de nombreux renvois: balisage sémantique et des liens automatiques pour les fonctions, les classes, les termes du glossaire et des informations similaires
& Nbsp; * la structure hiérarchique: définition simple d'un arbre du document, avec des liens automatiques vers les frères et sœurs, parents et enfants
& Nbsp; * indices automatiques: indice général ainsi qu'un index de module
& Nbsp; * la manipulation de code: mise en évidence automatique en utilisant le surligneur Pygments
& Nbsp; * Diverses extensions sont disponibles, par exemple . pour le test automatique des extraits et l'inclusion des docstrings format approprié
Exigences :
- Python
Commentaires non trouvées