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.

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 …

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 …

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 The Basics Installing Sphinx PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest development release …

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 …

Sphinx provides yet another level of automation: the autosummary extension. The autosummary directive generates documents that contain all the necessary autodoc directives.

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 …

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 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 …