Sphinx documentation contents

Get started

• Getting Started
  • Setting up the documentation sources
  • Defining document structure
  • Adding content
  • Running the build
  • Documenting objects
    • enumerate()
  • Basic configuration
  • Autodoc
  • Intersphinx
  • More topics to be covered
• Installing Sphinx
  • Overview
  • Linux
    • Debian/Ubuntu
    • RHEL, CentOS
    • Other distributions
  • macOS
    • Homebrew
    • MacPorts
    • Anaconda
  • Windows
    • Chocolatey
    • Other Methods
  • Installation from PyPI
    • Using virtual environments
  • Docker
  • Installation from source
• Tutorial: Build your first project
  • Getting started
    • Setting up your project and development environment
    • Creating the documentation layout
  • First steps to document your project using Sphinx
    • Building your HTML documentation
    • Building your documentation in other formats
  • More Sphinx customization
    • Enabling a built-in extension
    • Using a third-party HTML theme
  • Narrative documentation in Sphinx
    • Structuring your documentation across multiple pages
    • Adding cross-references
  • Describing code in Sphinx
    • Python
    • Other languages (C, C++, others)
  • Automatic documentation generation from code
    • Reusing signatures and docstrings with autodoc
    • Generating comprehensive API references
  • Appendix: Deploying a Sphinx project online
    • Sphinx-friendly deployment options
    • Embracing the “Docs as Code” philosophy
    • Publishing your documentation sources
    • Publishing your HTML documentation
  • Where to go from here

User Guides

• Using Sphinx
  • reStructuredText
    • reStructuredText Primer
    • Roles
    • Directives
    • Field Lists
    • Domains
  • Markdown
    • Configuration
  • Configuration
    • Project information
    • General configuration
    • Options for internationalization
    • Options for Math
    • 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 the linkcheck builder
    • Options for the XML builder
    • Options for the C domain
    • Options for the C++ domain
    • Options for the Python domain
    • Options for the Javascript domain
    • Example of configuration file
  • Builders
    • StandaloneHTMLBuilder
    • DirectoryHTMLBuilder
    • SingleFileHTMLBuilder
    • HTMLHelpBuilder
    • QtHelpBuilder
    • AppleHelpBuilder
    • DevhelpBuilder
    • Epub3Builder
    • LaTeXBuilder
    • TextBuilder
    • ManualPageBuilder
    • TexinfoBuilder
    • SerializingHTMLBuilder
    • PickleHTMLBuilder
    • JSONHTMLBuilder
    • MessageCatalogBuilder
    • ChangesBuilder
    • DummyBuilder
    • CheckExternalLinksBuilder
    • XMLBuilder
    • PseudoXMLBuilder
    • Serialization builder details
  • Extensions
    • Built-in extensions
    • Third-party extensions
  • HTML Theming
    • Builders
    • Themes
  • Internationalization
    • Sphinx internationalization details
    • Translating with sphinx-intl
    • Using Transifex service for team translation
    • Using Weblate service for team translation
    • Contributing to Sphinx reference translation
  • Sphinx Web Support
    • Web Support Quick Start
    • The WebSupport Class
    • Search Adapters
    • Storage Backends
• Writing Sphinx Extensions
  • Developing extensions overview
    • Make an extension depend on another extension
  • Extension tutorials
    • Developing a “Hello world” extension
    • Developing a “TODO” extension
    • Developing a “recipe” extension
    • Developing autodoc extension for IntEnum
  • Configuring builders
    • Discover builders by entry point
  • Templating
    • Do I need to use Sphinx’s templates to produce HTML?
    • Jinja/Sphinx Templating Primer
    • Working with the builtin templates
  • HTML theme development
    • Creating themes
    • Distribute your theme as a Python package
    • Templating
• LaTeX customization
  • The latex_elements configuration setting
  • The sphinxsetup configuration setting
  • Additional CSS-like 'sphinxsetup' keys
  • LaTeX macros and environments
    • Macros
    • The \sphinxbox command
    • Environments
    • Miscellany
• Sphinx Extensions API
  • Important objects
  • Build Phases
  • Extension metadata
  • APIs used for writing extensions
    • Application API
    • Project API
    • Build environment API
    • Builder API
    • Environment Collector API
    • Docutils markup API
    • Domain API
    • Parser API
    • Doctree node classes added by Sphinx
    • Logging API
    • i18n API
    • Utilities
    • Deprecated APIs

Community

• Get support
• Contribute to Sphinx
  • Contributing to Sphinx
    • Get help
    • Bug Reports and Feature Requests
    • Contribute code
    • Contribute documentation
    • Debugging tips
  • Sphinx’s release process
    • Versioning
    • Deprecating a feature
    • Deprecation policy
    • Python version support policy
    • Release procedures
  • Organization of the Sphinx project
    • Core developers
    • Other contributors
  • Sphinx Code of Conduct
• Sphinx FAQ
  • How do I…
  • Using Sphinx with…
  • Sphinx vs. Docutils
  • Epub info
  • Texinfo info
    • Displaying Links
    • Notes
• Sphinx authors
  • Maintainers
  • Contributors

Reference

• Command-Line Tools
  • Core Applications
    • sphinx-quickstart
    • sphinx-build
  • Additional Applications
    • sphinx-apidoc
    • sphinx-autogen
• Configuration
  • Project information
  • General configuration
  • Options for internationalization
  • Options for Math
  • 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 the linkcheck builder
  • Options for the XML builder
  • Options for the C domain
  • Options for the C++ domain
  • Options for the Python domain
  • Options for the Javascript domain
  • Example of configuration file
• Extensions
  • Built-in extensions
    • sphinx.ext.autodoc – Include documentation from docstrings
    • sphinx.ext.autosectionlabel – Allow reference sections using its title
    • sphinx.ext.autosummary – Generate autodoc summaries
    • sphinx.ext.coverage – Collect doc coverage stats
    • sphinx.ext.doctest – Test snippets in the documentation
    • sphinx.ext.duration – Measure durations of Sphinx processing
    • 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.imgconverter – A reference image converter using Imagemagick
    • 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 for HTML outputs in Sphinx
    • sphinx.ext.napoleon – Support for NumPy and Google style docstrings
    • 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?
• reStructuredText
  • reStructuredText Primer
    • Paragraphs
    • Inline markup
    • Lists and Quote-like blocks
    • Literal blocks
    • Doctest blocks
    • Tables
    • Hyperlinks
    • Sections
    • Field Lists
    • Roles
    • Explicit Markup
    • Directives
    • Images
    • Footnotes
    • Citations
    • Substitutions
    • Comments
    • HTML Metadata
    • Source encoding
    • Gotchas
  • Roles
    • Cross-referencing syntax
    • Inline code highlighting
    • Math
    • Other semantic markup
    • Substitutions
  • Directives
    • Table of contents
    • Paragraph-level markup
    • Showing code examples
    • Glossary
    • Meta-information markup
    • Index-generating markup
    • Including content based on tags
    • Tables
    • Math
    • Grammar production displays
  • Field Lists
    • File-wide metadata
    • Special metadata fields
  • Domains
    • Basic Markup
    • The Python Domain
    • The C Domain
    • The C++ Domain
    • The Standard Domain
    • The JavaScript Domain
    • The reStructuredText domain
    • The Math Domain
    • More domains
• 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