Sphinx ExtensionsΒΆ
Since many projects will need special features in their documentation, Sphinx allows adding “extensions” to the build process, each of which can modify almost any aspect of document processing.
This chapter describes the extensions bundled with Sphinx. For the API documentation on writing your own extension, see Developing extensions for Sphinx.
- Builtin Sphinx extensions
sphinx.ext.autodoc– Include documentation from docstringssphinx.ext.autosectionlabel– Allow reference sections using its titlesphinx.ext.autosummary– Generate autodoc summariessphinx.ext.coverage– Collect doc coverage statssphinx.ext.doctest– Test snippets in the documentationsphinx.ext.extlinks– Markup to shorten external linkssphinx.ext.githubpages– Publish HTML docs in GitHub Pagessphinx.ext.graphviz– Add Graphviz graphssphinx.ext.ifconfig– Include content based on configurationsphinx.ext.imgconverter– Convert images to appropriate format for builderssphinx.ext.inheritance_diagram– Include inheritance diagramssphinx.ext.intersphinx– Link to other projects’ documentationsphinx.ext.linkcode– Add external links to source code- Math support in Sphinx
sphinx.ext.napoleon– Support for NumPy and Google style docstringssphinx.ext.todo– Support for todo itemssphinx.ext.viewcode– Add links to highlighted source code
- Third-party extensions