Sphinx documentation contents — Sphinx documentation (original) (raw)

GitHub Expand

The Basics

User guide

Community

Reference

Command-line tools
- Core applications
  * sphinx-quickstart
  * sphinx-build
- Additional applications
  * sphinx-apidoc
  * sphinx-autogen
Configuration
Extensions
- Built-in extensions
  * sphinx.ext.apidoc – Generate API documentation from Python packages
  * sphinx.ext.autodoc – Include documentation from docstrings
  * sphinx.ext.autosectionlabel – Allow referencing sections by their 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-references
  * 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
- MOVED: Domains
  * MOVED: Basic Markup
  * MOVED: Python Domain
  * MOVED: C Domain
  * MOVED: C++ Domain
  * MOVED: Standard Domain
  * MOVED: JavaScript Domain
  * MOVED: reStructuredText Domain
  * MOVED: Math Domain
  * MOVED: More domains
Glossary
Changelog
- Release 8.3.0 (in development)
  * Dependencies
  * Incompatible changes
  * Deprecated
  * Features added
  * Bugs fixed
  * Testing
- Prior releases
  * Sphinx 8.2
  * Sphinx 8.1
  * Sphinx 8.0
  * Sphinx 7.4
  * Sphinx 7.3
  * Sphinx 7.2
  * Sphinx 7.1
  * Sphinx 7.0
  * Sphinx 6.2
  * Sphinx 6.1
  * Sphinx 6.0
  * Sphinx 5.3
  * Sphinx 5.2
  * Sphinx 5.1
  * Sphinx 5.0
  * Sphinx 4.5
  * Sphinx 4.4
  * Sphinx 4.3
  * Sphinx 4.2
  * Sphinx 4.1
  * Sphinx 4.0
  * Sphinx 3.5
  * Sphinx 3.4
  * Sphinx 3.3
  * Sphinx 3.2
  * Sphinx 3.1
  * Sphinx 3.0
  * Sphinx 2.4
  * Sphinx 2.3
  * Sphinx 2.2
  * Sphinx 2.1
  * Sphinx 2.0
  * Sphinx 1.8
  * Sphinx 1.7
  * Sphinx 1.6
  * Sphinx 1.5
  * Sphinx 1.4
  * Sphinx 1.3
  * Sphinx 1.2
  * Sphinx 1.1
  * Sphinx 1.0
  * Sphinx 0.6
  * Sphinx 0.5
  * Sphinx 0.4
  * Sphinx 0.3
  * Sphinx 0.2
  * Sphinx 0.1
Projects using Sphinx