Sphinx (documentation generator)
 | |
| Developer(s) | Georg Brandl |
|---|---|
| Initial release | March 21, 2008 |
| Stable release | 7.2.6[1]
/ September 13, 2023 |
| Repository |
|
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | BSD |
| Website | www.sphinx-doc.org |
Sphinx is a documentation generator written and used by the Python community. It is written in Python, and also used in other environments.
Purpose and function
Sphinx converts reStructuredText files into HTML websites and other formats including PDF, EPub, Texinfo and man.
reStructuredText is extensible, and Sphinx exploits its extensible nature through a number of extensions – for autogenerating documentation from source code, writing mathematical notation or highlighting source code, etc.
HTML themes
Sphinx provides the ability to apply themes to HTML and HTML-based formats. Sphinx has several built-in themes, including alabaster, classic, sphinxdoc, and scrolls.[2] Popular themes that can be installed as Python modules include:[3]
- Read the Docs[4]
- Sphinx Bootstrap[5]
- Guzzle[6]
- Documatt[7]
History and use
The first public release, version 0.1.61611, was announced on March 21, 2008.[8] It was developed for, and is used extensively by, the Python project for documentation.[9]
Since its introduction in 2008, Sphinx has been adopted by many other important Python projects, including Bazaar, SQLAlchemy, MayaVi, SageMath, SciPy, Django and Pylons. It is also used for the Blender user manual[10] and Python API documentation.[11]
In 2010, Eric Holscher announced[12] the creation of the Read the Docs project as part of an effort to make maintenance of software documentation easier. Read the Docs automates the process of building and uploading Sphinx documentation after every commit.
Linux kernel
The Linux kernel's documentation subsystem underwent changes in 2016. Starting in the 4.7 cycle, the documentation started switching over to use Sphinx.[13]
- Talk at LCA2016: What I've learned as the kernel docs maintainer on YouTube
- Talk at LCA2017: Kernel documentation: what we have and where it's going on YouTube
See also
References
- ^ "Changes in Sphinx". Sphinx.
- ^ "HTML Theming". Sphinx documentation. Georg Brandl and the Sphinx team. Retrieved 2022-06-25.
- ^ "Sphinx Themes". Write the Docs. Retrieved 2022-06-25.
- ^ "Read the Docs Sphinx Theme". sphinx-rtd-theme code repository. GitHub. Retrieved 2022-06-25.
- ^ "Sphinx Bootstrap Theme". sphinx_bootstrap_theme code repository. GitHub. Retrieved 2022-06-25.
- ^ "Guzzle Sphinx Theme". guzzle_sphinx_theme code repository. GitHub. Retrieved 2022-06-25.
- ^ "Documatt Sphinx Themes Collection". Documatt.com. Retrieved 2022-06-25.
- ^ "Sphinx is released! » And now for something completely Pythonic..." And now for something completely Pythonic... Georg Brandl. Archived from the original on 2012-03-22. Retrieved 2011-04-03.
- ^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. Retrieved 2011-04-03.
- ^ "Blender User Manual". Blender Wiki. Blender Foundation.
- ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Foundation. Blender Foundation.
- ^ "Announcing Read The Docs". Python Software Foundation News. Eric Holscher. Retrieved 2015-02-15.
- ^ "Kernel documentation update". LWN.net. 2016-11-02.
External links
- Sphinx documentation generator project website
- Read the Docs large-scale, collaborative documentation host powered by Sphinx