Sphinx¶
Create intelligent and beautiful documentation with ease
📝 Rich Text Formatting
Author in reStructuredText or MyST Markdown to create highly structured technical documents, including tables, highlighted code blocks, mathematical notations, and more.
🔗 Powerful Cross-Referencing
Create cross-references within your project, and even across different projects. Include references to sections, figures, tables, citations, glossaries, code objects, and more.
📚 Versatile Documentation Formats
Generate documentation in the preferred formats of your audience, including HTML, LaTeX (for PDF), ePub, Texinfo, and more.
🎨 Extensive Theme Support
Create visually appealing documentation, with a wide choice of built-in and third-party HTML themes and the ability to customize or create new themes.
🔌 Fully Extensible
Add custom functionality, via robust extension mechanisms with numerous built-in and third-party extensions available for tasks like creating diagrams, testing code, and more.
🛠️ Automatic API Documentation
Generate API documentation for Python, C++ and other software domains, manually or automatically from docstrings, ensuring your code documentation stays up-to-date with minimal effort.
🌍 Internationalization (i18n)
Add documentation translations multiple languages to reach a global audience.
🌟 Active Community and Support
Benefit from an active community, with numerous resources, tutorials, forums, and examples.
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.
User guide¶
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.
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 User guide.
Références
- Command-line tools
- Configuration
- Extensions
- reStructuredText
- Glossaire
- Historique des modifications
- Projets utilisant Sphinx
- Documentation utilisant le thème alabaster
- Documentation utilisant le thème classique
- Documentation utilisant le thème sphinxdoc
- Documentation utilisant le thème nature
- Documentation utilisant un autre thème intégré
- Documentation using Read the Docs Sphinx Theme
- Documentation using Sphinx Bootstrap Theme
- Documentation using PyData Sphinx Theme
- Documentation using Furo theme
- Documentation utilisant un thème personnalisé ou intégrée dans un site Web
- Pages d’accueil et autres sites non documentés
- Livres produits avec Sphinx
- Thèses réalisées avec Sphinx
- Projets intégrant la fonctionnalité Sphinx