Contenu de la documentation Sphinx
The Basics
- Installer Sphinx
- Démarrer avec Sphinx
- Build your first project
User guide
- Utiliser Sphinx
- reStructuredText
- Markdown
- Cross-references
- Configuration
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- Détails du constructeur de la sérialisation
- Domains
- Extensions
- HTML theming
- Internationalisation
- Sphinx Web Support
- Étendre Sphinx
- Sphinx API
- LaTeX customization
Communauté
- Obtenir de l’aide
- Contribuer à Sphinx
- FAQ Sphinx
- Auteurs de Sphinx
Références
- Command-line tools
- Configuration
- Project tags
- Informations sur le projet
- Configuration générale
needs_sphinxextensionsneeds_extensionsmanpages_urltodaytoday_fmt- Options for figure numbering
- Options for highlighting
- Options for HTTP requests
- Options for internationalisation
- Options for markup
- Options for Maths
- Options for the nitpicky mode
- Options for object signatures
- Options for source files
- Options for smart quotes
- Options for templating
- Options for warning control
- Builder options
- Options pour la sortie HTML
- Options for Single HTML output
- Options for HTML help output
- Options for Apple Help output
- Options for EPUB output
- Options pour la sortie LaTeX
- Options pour la sortie text
- Options for manual page output
- Options pour la sortie Texinfo
- Options pour la sortie QtHelp
- Options for XML output
- Options for the linkcheck builder
- Domain options
- Options d’extension
- Example configuration file
- Extensions
- Built-in extensions
sphinx.ext.apidoc– Generate API documentation from Python packagessphinx.ext.autodoc– Inclure la documentation des chaînes docstringssphinx.ext.autosectionlabel– Allow referencing sections by their titlesphinx.ext.autosummary– Generate autodoc summariessphinx.ext.coverage– Collecte les statistiques de couverture de docsphinx.ext.doctest– Test snippets in the documentationsphinx.ext.duration– Mesurer les durées de traitement du Sphinxsphinx.ext.extlinks– Balisage pour raccourcir les liens externessphinx.ext.githubpages– Publie les documents HTML sur GitHub Pagessphinx.ext.graphviz– Ajouter des graphiques Graphvizsphinx.ext.ifconfig– Inclure du contenu basé sur la configurationsphinx.ext.imgconverter– Un convertisseur d’image de référence utilisant ImageMagicksphinx.ext.inheritance_diagram– Inclure les diagrammes d’héritagesphinx.ext.intersphinx– Lien vers la documentation d’autres projetssphinx.ext.linkcode– Ajouter des liens externes au code source- Math support for HTML outputs in Sphinx
sphinx.ext.napoleon– Support for NumPy and Google style docstringssphinx.ext.todo– Prise en charge des éléments todosphinx.ext.viewcode– Add links to highlighted source code
- Extensions tierces
- Built-in extensions
- reStructuredText
- Glossaire
- Historique des modifications
- Release 9.1.1 (in development)
- Release 9.1.0 (released Dec 31, 2025)
- Prior releases
- Sphinx 9.0
- Sphinx 8.2
- Sphinx 8.1
- Sphinx 8.0
- Sphinx 7.4
- Sphinx 7.3
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Sphinx 1.3
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1
- 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