Sphinx documentation contents
The Basics
- Installing Sphinx
- Getting Started
- Build your first project
User Guides
- Using Sphinx
- reStructuredText
- Markdown
- Cross-referencing syntax
- Configuration
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- Serialization builder details
- Domains
- Extensions
- HTML Theming
- Internationalization
- Sphinx Web Support
- Extending Sphinx
- Sphinx API
- LaTeX customization
Community
- Get support
- Contribute to Sphinx
- Sphinx FAQ
- Sphinx authors
Reference
- Command-Line Tools
- Configuration
- Project tags
- Project information
- General configuration
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 for HTML output
- Options for Single HTML output
- Options for HTML help output
- Options for Apple Help output
- Options for EPUB output
- Options for LaTeX output
- Options for text output
- Options for manual page output
- Options for Texinfo output
- Options for QtHelp output
- Options for XML output
- Options for the linkcheck builder
- Domain options
- Extension options
- Example configuration file
- Extensions
- Built-in 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.duration– Measure durations of Sphinx processingsphinx.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– A reference image converter using Imagemagicksphinx.ext.inheritance_diagram– Include inheritance diagramssphinx.ext.intersphinx– Link to other projects’ documentationsphinx.ext.linkcode– Add external links to source code- Math support for HTML outputs 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
- Built-in extensions
- reStructuredText
- Glossary
- Changelog
- Projects using Sphinx
- Documentation using the alabaster theme
- Documentation using the classic theme
- Documentation using the sphinxdoc theme
- Documentation using the nature theme
- Documentation using another builtin theme
- Documentation using sphinx_rtd_theme
- Documentation using sphinx_bootstrap_theme
- Documentation using pydata_sphinx_theme
- Documentation using a custom theme or integrated in a website
- Homepages and other non-documentation sites
- Books produced using Sphinx
- Theses produced using Sphinx
- Projects integrating Sphinx functionality