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.

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 …

Getting started Setting up your project and development environment Creating the documentation layout First steps to document your project using Sphinx Building your HTML documentation Building your …

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 …

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

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 …

This is an incomplete list of projects that use Sphinx for their documentation. If you would like to add a project, please create an issue or pull request on GitHub.

Sphinx supports a variety of formats apart from HTML, including PDF, EPUB, and more. For example, to build your documentation in EPUB format, run this command from the docs directory:

Feb 26, 2018 · 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 …