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.

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 …

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 …

This guide serves to demonstrate how one can get started with Sphinx and covers everything from installing Sphinx and configuring your first Sphinx project to using some of the advanced features …

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.ext.apidoc – Generate API documentation from Python packages sphinx.ext.autodoc – Include documentation from docstrings sphinx.ext.autosectionlabel – Allow referencing sections by their title …

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.

The rest of this page describes some high-level aspects of developing extensions and various parts of Sphinx’s behavior that you can control. For some examples of how extensions can be built and used …

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 …