Builtin Sphinx extensions¶
These extensions are built in and can be activated by respective entries in the extensions
configuration value:
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.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