Sphinx documentation contents
sphinx.ext.apidoc – Generate API documentation from Python packages sphinx.ext.autodoc – Include documentation from docstrings sphinx.ext.autosectionlabel – Allow referencing …
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 …
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 …
Using Sphinx — Sphinx documentation
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 …
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 …
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 …
Projects using Sphinx
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.
First steps to document your project using Sphinx
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:
Changelog — Sphinx documentation
Feb 26, 2018 · #14022: Use MathJax v4 by default in the sphinx.ext.mathjax extension, from v3 previously. To keep using an older version, set the mathjax_path option. Also add the new …
Internationalization — Sphinx documentation
Complementary to translations provided for Sphinx-generated messages such as navigation bars, Sphinx provides mechanisms facilitating the translation of documents.