
Sphinx
A documentation generator supporting structured references, cross-references and Python API documentation workflows.

About Sphinx
Sphinx is an open-source documentation generator. Authors write source files in reStructuredText or MyST Markdown, and Sphinx builds them into structured technical documents that can include tables, highlighted code blocks and mathematical notation. It can generate API documentation for Python, C++ and other software domains from docstrings, which helps keep code documentation aligned with the code. Output can be produced in HTML, LaTeX (for PDF), ePub and Texinfo.
Sphinx supports built-in and third-party HTML themes, which can be customized or replaced, and it can be extended with additional functionality. Documentation can be translated into multiple languages. The homepage lists Python, the Linux Kernel and Project Jupyter among projects that use it. The user guide assumes more knowledge of Sphinx, and the site recommends new users begin with the Get started section.
Key features
- Authoring in reStructuredText or MyST Markdown source files
- Cross-references to sections, figures, tables, citations, glossaries and code objects
- Cross-references across different Sphinx projects
- Output in HTML, LaTeX (PDF), ePub and Texinfo formats
- Built-in and third-party HTML themes that can be customized or created
- Automatic API documentation for Python, C++ and other domains from docstrings
- Open source and listed as free
- Generates API documentation from docstrings, which can reduce manual upkeep
- The homepage describes an active community with resources, tutorials, forums and examples
- The user guide assumes more knowledge of Sphinx, and new users are directed to the Get started section first
Sphinx at a glance
- Website
- sphinx-doc.org
- Category
- Development › Developer Tools
- Type
- Online tool
- Pricing
- Free
- Open source
- Yes
- Last checked
- Oct 9, 2026 · Online when checked
- Listed
- Oct 9, 2026
Guides for Developer Tools
Sphinx alternatives
Tools and sites you could use instead, ranked by how closely they match.
Search more than 100 technology references in DevDocs, an offline documentation browser for developers.
A static documentation generator using Markdown pages and a YAML project configuration.
A Markdown-based book and documentation generator for material organized in chapter order.
API references for developers can be browsed in DevDocs, a documentation browser.
Vaex provides out-of-core DataFrames for Python to explore and visualize large tabular datasets, with support for machine learning workflows.
The imbalanced-learn documentation explains tools for learning from imbalanced datasets in Python.
Featured in
8 sites8 Best Documentation Site Generators for Product and Project Docs
For documentation site generators, I'd start with Docusaurus when product versions and interactive examples matter, and…
Popular in Developer Tools
Well-known listings from the same topic.
Sphinx FAQ
Can Sphinx generate API documentation from code?
What output formats does Sphinx support?
Can Sphinx documentation be translated?
Tell us and an editor will check it.
Claim the listing and suggest updates yourself. An editor checks every claim first.














