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 …
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 …
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 …
sphinx.ext.autodoc – Include documentation from docstrings
For importing to work, you have to make sure that your modules can be found by Sphinx and that dependencies can be resolved (if your module does importfoo, but foo is not available in the …
reStructuredText Primer — Sphinx documentation
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 …
sphinx-build — Sphinx documentation
Changed in version 8.1: sphinx-build no longer exits on the first warning, meaning that in effect --keep-going is always enabled. The option is retained for compatibility, but may be removed at …
Configuration — Sphinx documentation
This is useful to copy files that Sphinx doesn’t copy automatically, or to overwrite Sphinx LaTeX support files with custom versions. Image files that are referenced in source files (e.g. via .. …
Directives — Sphinx documentation
Sphinx knows the relative order of the documents intro, strings and so forth, and it knows that they are children of the shown document, the library index. From this information it generates “next …
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 …
Internationalization — Sphinx documentation
Complementary to translations provided for Sphinx-generated messages such as navigation bars, Sphinx provides mechanisms facilitating the translation of documents.