Sphinx is a free, open-source documentation generator used for Python's official docs and countless technical projects. Learn features and use cases.
Sphinx is an open-source documentation generator originally built in 2007 by Georg Brandl, a core Python developer, to replace the informal scripts and LaTeX-based toolchain that had produced Python's official documentation up to that point.
Sphinx takes structured source text, primarily written in reStructuredText, and compiles it into polished output formats such as HTML, PDF, and ePub. It has become the de facto standard documentation tool across much of the Python ecosystem and is also used for documentation in other languages and projects.
The project is licensed under the permissive BSD 2-Clause license and maintained by a community of contributors known collectively as the Sphinx team, with maintainers including Adam Turner and Takeshi Komiya.
Sphinx supports reStructuredText as its primary markup language, with Markdown support available through extensions such as MyST. Its autodoc extension can automatically generate API reference documentation directly from Python docstrings, and its cross-referencing system lets documentation link cleanly across pages, modules, and external projects.
Sphinx is completely free and open source. There is no paid tier, subscription, or license fee; it is distributed via PyPI and can be installed and used without restriction under the BSD 2-Clause license.
Sphinx is used to generate technical and API documentation from source text, compiling it into formats such as HTML and PDF.
Yes, Sphinx is free, open-source software released under the BSD 2-Clause license.
Sphinx was created in 2007 by Georg Brandl, a core Python developer, to replace Python's earlier documentation toolchain.
Sphinx's primary markup language is reStructuredText, but Markdown is supported through extensions such as MyST.
Sphinx was originally built for Python's documentation but is used across many languages and types of technical documentation.
Autodoc is a Sphinx extension that automatically generates API reference documentation from Python docstrings.
Yes, Sphinx is widely supported by Read the Docs and other documentation hosting platforms for automated building and publishing.