| Sphinx | |
|---|---|
 | |
| Developers | Georg Brandl, Adam Turner[1] |
| Initial release | March 21, 2008 (2008-03-21) |
| Stable release | |
| Repository | |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | BSD |
| Website | www |
Sphinx is adocumentation generator written and used by the Python community. It is written inPython, and also used in other environments.
Sphinx convertsreStructuredText files intoHTMLwebsites and other formats includingPDF,EPub,Texinfo andman.
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.
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.[3] Popular themes that can be installed as Python modules include:[4]
The first public release, version 0.1.61611, was announced on March 21, 2008.[9] It was developed for, and is used extensively by, thePython project for documentation.[10]
Since its introduction in 2008, Sphinx has been adopted by many other important Python projects, includingBazaar,SQLAlchemy,MayaVi,SageMath,SciPy,Django andPylons. It is also used for theBlender user manual[11][failed verification] and Python API documentation.[12][failed verification]
In 2010, Eric Holscher announced[13] the creation of theRead 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 everycommit.
The Linux kernel's documentation subsystem underwent changes in 2016. Starting in the 4.7 cycle, the documentation started switching over to use Sphinx.[14]
