Sphinx — Sphinx documentation
These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx.
Getting started — Sphinx documentation
Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities. The goal of this document is to …
Build your first project — Sphinx documentation
In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML. The project will include narrative, handwritten documentation, as well as autogenerated API …
Sphinx documentation contents
Sphinx documentation contents The Basics Installing Sphinx PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release …
Changelog — Sphinx documentation
Dec 31, 2025 · Sphinx 1.4 Release 1.4.9 (released Nov 23, 2016) Release 1.4.8 (released Oct 1, 2016) Release 1.4.7 (released Oct 1, 2016) Release 1.4.6 (released Aug 20, 2016) Release 1.4.5 …
Automatic documentation generation from code - Sphinx doc
While using sphinx.ext.autodoc makes keeping the code and the documentation in sync much easier, it still requires you to write an auto* directive for every object you want to document.
Builders — Sphinx documentation
This builder is used for debugging the Sphinx/Docutils “Reader to Transform to Writer” pipeline. It produces compact pretty-printed “pseudo-XML”, files where nesting is indicated by indentation (no …
reStructuredText — Sphinx documentation
Docutils provides the basic reStructuredText syntax, while Sphinx extends this to support additional functionality. The below guides go through the most important aspects of reStructuredText.
reStructuredText Primer — Sphinx documentation
reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with …
Domains — Sphinx documentation
While this was always possible, it is now much easier to easily support documentation of projects using different programming languages or even ones not supported by the main Sphinx distribution, by …