Bienvenue

Sphinx facilite la création de documentations belles et intelligentes.

Voici quelques-unes des fonctionnalités majeures de Sphinx :

  • Formats de sortie : HTML (y compris Aide HTML Windows), LaTeX (pour les versions imprimables PDF), ePub, Texinfo, pages de manuel, texte brut.

  • Références croisées étendues : balisage sémantique et liens automatiques pour les fonctions, classes, citations, termes de glossaire et éléments d’information similaires.

  • Structure hiérarchique : définition aisée d’une arborescence de document, avec liens automatiques vers les nœuds frères, parents et enfants.

  • Index automatiques : index général ainsi que les index de modules spécifiques aux langages.

  • Gestion du code : coloration syntaxique automatique en utilisant l’outil Pygments.

  • Extensions : test automatique des extraits de code, inclusion des docstrings depuis les modules Python (documentations d’API) grâce aux extensions intégrées, et bien plus encore grâce aux extensions tierces.

  • Themes: modify the look and feel of outputs via creating themes, and reuse many third-party themes.

  • Contribution d’extensions : des douzaines d’extensions développées par les utilisateurs; la plupart installable depuis PyPI.

Sphinx utilise le langage de balisage reStructuredText par défaut, et peut lire le MyST markdown grâce à des extensions tierces. Les deux sont à la fois puissants, simples à utiliser, et offrent des fonctionnalités pour les documentations et flux de publication complexes. Tous deux s’appuient sur Docutils pour lire et écrire les documents.

Voir ci-dessous comment naviguer dans la documentation de Sphinx.

Voir aussi

La Table des Matières de la documentation de Sphinx présente une liste complète des pages de ce site.

Démarrer avec Sphinx

Ces sections couvrent les bases du démarrage avec Sphinx, incluant la création et la construction de votre propre documentation à partir de zéro.

Démarrer avec Sphinx

Guides Utilisateurs

Ces sections couvrent divers sujets concernant l’utilisation et l’extension de Sphinx dans différents cas d’utilisation. Elles sont un guide complet à l’utilisation de Sphinx dans de nombreux contextes et supposent une plus grande connaissance de Sphinx. Si vous débutez avec Sphinx, nous vous recommandons de commencer par Démarrer avec Sphinx.

Guides Utilisateurs

Guide de la communauté

Sphinx est supporté par sa communauté et accueille les contributions de quiconque. Les sections ci-dessous devraient vous accompagner pour rejoindre la communauté Sphinx ainsi que pour contribuer.

Référez-vous au Guide du contributeur Sphinx si vous souhaitez contribuer au projet.

Communauté

Guide de référence

La documentation de référence est plus complète et programmatique par nature, c’est une collection d’informations pouvant être rapidement référencées. Si vous souhaitez une documentation orientée cas d’utilisation, référez-vous au Démarrer avec Sphinx ou au Guides Utilisateurs.

Références