Sphinx Extensions

Since many projects will need special features in their documentation, Sphinx allows to add “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 docstrings
    • Docstring preprocessing
    • Skipping members
  • sphinx.ext.autosectionlabel – Allow reference sections using its title
  • sphinx.ext.autosummary – Generate autodoc summaries
    • sphinx-autogen – generate autodoc stub pages
    • Generating stub pages automatically
    • Customizing templates
  • sphinx.ext.coverage – Collect doc coverage stats
  • sphinx.ext.doctest – Test snippets in the documentation
    • Directives
    • Configuration
  • sphinx.ext.extlinks – Markup to shorten external links
  • sphinx.ext.githubpages – Publish HTML docs in GitHub Pages
  • sphinx.ext.graphviz – Add Graphviz graphs
  • sphinx.ext.ifconfig – Include content based on configuration
  • sphinx.ext.inheritance_diagram – Include inheritance diagrams
  • sphinx.ext.intersphinx – Link to other projects’ documentation
  • sphinx.ext.linkcode – Add external links to source code
  • Math support in Sphinx
    • sphinx.ext.imgmath – Render math as images
    • sphinx.ext.mathjax – Render math via JavaScript
    • sphinx.ext.jsmath – Render math via JavaScript
  • sphinx.ext.napoleon – Support for NumPy and Google style docstrings
    • Napoleon - Marching toward legible docstrings
      • Getting Started
      • Docstrings
      • Docstring Sections
      • Google vs NumPy
      • Type Annotations
    • Configuration
  • sphinx.ext.todo – Support for todo items
  • sphinx.ext.viewcode – Add links to highlighted source code
• Third-party extensions
  • Where to put your own extensions?