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
The goal of this document is to give you a quick taste of what Sphinx is and how you might use it. When you’re done here, you can check out the installation guide followed by the intro to the default markup …
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 …
Installing Sphinx — Sphinx documentation
You may install a global version of Sphinx into your system using OS-specific package managers. However, be aware that this is less flexible and you may run into compatibility issues if you want to …
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 …
Automatic documentation generation from code - Sphinx doc
In the previous section of the tutorial you manually documented a Python function in Sphinx. However, the description was out of sync with the code itself, since the function signature was not the same.
Cross-references — Sphinx documentation
Sphinx supports various cross-referencing roles to create links to other elements in the documentation. In general, writing :role:`target` creates a link to the object called target of the type indicated by role.
Changelog — Sphinx documentation
Dec 31, 2025 · Sphinx 1.6 Release 1.6.7 (released Feb 04, 2018) Release 1.6.6 (released Jan 08, 2018) Release 1.6.5 (released Oct 23, 2017) Release 1.6.4 (released Sep 26, 2017) Release 1.6.3 …
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.
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 …