Bienvenue

Ce que les utilisateurs disent :

“Félicitations pour un outil génial qui donne envieaux développeurs d'écrire de la documentation!“

Sphinx est un outil qui facilite la création d'une documentation belle et intelligente, écrit par Georg Brandl et édité sous licence BSD.

Il a été créé au départ pour la documentation Python , et il a d'excellents utilitaires pour la documentation de projets informatiques dans de nombreux langages. Bien sûr, ce site est aussi créé depuis des sources reStructuredText via Sphinx! Les fonctionnalités suivantes sont à mettre en avant :

  • Formats de sortie : HTML (y compris Windows HTML Help), LaTeX (pour des versions PDF imprimmable), ePub, Texinfo, pages man, texte brut
  • Références croisées étendues : balisage sémantique et liens automatiques pour les fonctions, classes, citations, termes de glossaires et les informations de même type
  • Structure hiérarchique : définition facile d'un arbre de document, avec liens automatiques vers les frères, parents et enfants
  • Index automatiques : index général ainsi que des indexes de modules spécifiques par langues
  • Gestion de code : coloration syntaxique automatique via Pygments
  • Extensions: test automatique de fragments de code, inclusion des docstrings des modules Python (API docs), et plus
  • Contributed extensions: dozens of extensions contributed by users; most of them installable from PyPI

Sphinx utilise reStructuredText comme langage de balisage, et beaucoup de ses forces viennent de la puissance et de la simplicité de reStructuredText et de sa suite de d'analyse et de traduction, Docutils.

Documentation

Vous pouvez aussi télécharger les versions PDF/EPUB de la documentation Sphinx depuis le menu popup dans le coin en bas à droite.

Exemples

Links to documentation generated with Sphinx can be found on the Projects using Sphinx page.

For examples of how Sphinx source files look, use the “Show source” links on all pages of the documentation apart from this welcome page.

You may also be interested in the very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers.

There is a translation team in Transifex of this documentation, thanks to the Sphinx document translators.

A Japanese book about Sphinx has been published by O'Reilly: Sphinxをはじめよう / Learning Sphinx.

In 2019 the second edition of a German book about Sphinx was published: Software-Dokumentation mit Sphinx.

Hosting

Need a place to host your Sphinx docs? readthedocs.org hosts a lot of Sphinx docs already, and integrates well with projects' source control. It also features a powerful built-in search that exceeds the possibilities of Sphinx' JavaScript-based offline search.

Contributor Guide

If you want to contribute to the project, this part of the documentation is for you.

Code of Conduct

Please adhere to our Code of Conduct.