About Sphinx
Sphinx is a documentation generator that turns plain text source files into finished documentation sites and printable formats. It is used by many large Python projects and supports a wide range of output types.
What it does
You write your pages in reStructuredText or MyST Markdown, and Sphinx builds them into HTML, LaTeX for PDF, ePub and other formats. It can also pull API reference pages straight from code docstrings, so the reference stays close to the source it describes. Cross-references let a page link to a section, figure or glossary term in the same project or in another one.
Key features
- Rich text markup with tables, code blocks and math
- Cross-references between sections, figures and projects
- API documentation generated from docstrings
- Built-in and third-party HTML themes
- Support for translated documentation
Who it's for
Sphinx suits Python developers and maintainers who need long, structured technical documentation. Teams with readers in several languages also benefit from its translation support.
Pricing and good to know
Sphinx is run from the command line in a Python environment, and its getting started guide walks through building a first project. Its extension system is broad, so a project may need a few extensions to match a specific workflow. The project has a large community and a published guide for contributors.
Highlights
- Writes pages in reStructuredText or MyST Markdown
- Builds HTML, LaTeX for PDF and ePub output
- Generates API reference from Python docstrings
- Links between sections in one or many projects
- Extends with themes and third-party extensions
