Sphinx (documentation generator): Difference between revisions
ChrstphrChvz (talk | contribs) m latest version is 1.8.3 |
ChrstphrChvz (talk | contribs) m fix broken link |
||
| Line 11: | Line 11: | ||
| released = {{Start date|2008|03|21}} |
| released = {{Start date|2008|03|21}} |
||
| discontinued = |
| discontinued = |
||
| latest release version = 1.8.3<ref>{{cite web|title=Changes in Sphinx|url=http://sphinx-doc.org/ |
| latest release version = 1.8.3<ref>{{cite web|title=Changes in Sphinx|url=http://www.sphinx-doc.org/en/master/changes.html}}</ref> |
||
| latest release date = {{Start date and age|2018|12|25}} |
| latest release date = {{Start date and age|2018|12|25}} |
||
| latest preview version = 2.0.0 |
| latest preview version = 2.0.0 |
||
Revision as of 08:36, 8 January 2019
 | |
| Developer(s) | Georg Brandl |
|---|---|
| Initial release | March 21, 2008 |
| Stable release | 1.8.3[1]
/ December 25, 2018 |
| Preview release | 2.0.0
|
| Repository | |
| Written in | Python |
| Operating system | Cross-platform |
| Type | Documentation generator |
| License | BSD |
| Website | sphinx-doc |
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.
History and use
The first public release, version 0.1.61611, was announced on March 21, 2008.[2] It was developed for, and is used extensively by, the Python project for documentation.[3]
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[4] and Python API documentation.[5]
In 2010, Eric Holscher announced[6] 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.[7]
- 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 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.
{{cite web}}: Unknown parameter|deadurl=ignored (|url-status=suggested) (help) - ^ "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