Getting started — Sphinx documentation
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 give you a quick taste of what Sphinx is and how you might use it.
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 features Sphinx provides out-of-the-box.
Installing Sphinx — Sphinx documentation
Installing Sphinx¶ Sphinx is a Python application. It can be installed in one of the ways described below. Installation methods. PyPI package. Conda package. OS-specific package manager. Linux. macOS. Windows. Docker. Installation of the latest development release. Installation from source. After installation, you can check that Sphinx is ...
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 autogenerated API documentation.
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 Sphinx. If you are new to Sphinx, we recommend starting with Get started.
Sphinx documentation contents
sphinx.ext.autosectionlabel – Allow referencing sections by their title; sphinx.ext.autosummary – Generate autodoc summaries; sphinx.ext.coverage – Collect doc coverage stats; sphinx.ext.doctest – Test snippets in the documentation; sphinx.ext.duration – Measure durations of Sphinx processing; sphinx.ext.extlinks – Markup to shorten ...
Configuration — Sphinx documentation
This file (containing Python code) is called the “build configuration file” and contains (almost) all configuration needed to customise Sphinx input and output behaviour. An optional file docutils.conf can be added to the configuration directory to adjust Docutils configuration if not otherwise overridden or set by Sphinx.
Automatic documentation generation from code - Sphinx doc
While using sphinx.ext.autodoc makes keeping the code and the documentation in sync much easier, it still requires you to write an auto* directive for every object you want to document. Sphinx provides yet another level of automation: the autosummary extension.
Sphinx FAQ — Sphinx documentation
Sphinx FAQ¶ This is a list of Frequently Asked Questions about Sphinx. Feel free to suggest new entries! How do I…¶ … create PDF files without LaTeX? rinohtype provides a PDF builder that can be used as a drop-in replacement for the LaTeX builder. … get section numbers?
Cross-references — Sphinx documentation
One of Sphinx’s most useful features is creating automatic cross-references through semantic cross-referencing roles. A cross reference to an object description, such as :func:`spam`, will create a link to the place where spam() is documented, appropriate to each output format (HTML, PDF, ePUB, etc.). Syntax¶