Sphinx is a documentation generator that converts files in reStructuredText format to HTML website and other formats ( PDF , EPub and man ). It uses a number of extensions for reStructuredText (for example, to automatically generate source code documentation, create mathematical formulas, or highlight source code). The first public release (version 0.1.61611) was announced on March 21, 2008. [2] It was developed and is widely used to document the Python programming language , as well as its additional modules. [3]
| Sphinx | |
|---|---|
| Type of | Documentation Generator |
| Developer | Georg brandl |
| Written on | Python |
| operating system | cross-platform software |
| First edition | March 21, 2008 |
| Latest version | 1.6.7 [1] (July 2, 2017 ) |
| License | BSD |
| Website | sphinx-doc.org |
Since its introduction in 2008, Sphinx has been hosted by many important Python projects: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django and Pylons ; It is also used to document the Blender Python API. [4] To facilitate software documentation support, the Read the Docs project was created. [5] It automates the process of creating and loading Sphinx documentation after each commit of changes in the source code. The project is sponsored by the Python Software Foundation . [6]
See also
- reStructuredText
Links
- ↑ Changes in Sphinx .
- ↑ Sphinx is released! "And now for something completely Pythonic ... unspecified . And now for something completely Pythonic .... Georg Brandl. Date of treatment April 3, 2011. Archived January 26, 2013.
- ↑ About these documents - Python v2.7.1 documentation unspecified . Python documentation . Python Software Foundation. Date of treatment April 3, 2011. Archived January 26, 2013.
- ↑ Dev: 2.5 / Py / API / Generating API Reference - BlenderWiki! (inaccessible link) . Blender Wiki . Blender Foundation. Date of treatment April 6, 2011. Archived January 26, 2013.
- ↑ Announcing Read The Docs . Surfing in Kansas . Eric Holscher. Date of treatment April 6, 2011. Archived January 26, 2013.
- ↑ Python Software Foundation News: PSF Funds readthedocs.org unopened . Python Software Foundation News . Python Software Foundation. Date of treatment April 6, 2011. Archived January 26, 2013.
Literature
- sphinx-doc.org - official site of Sphinx
- Projects using Sphinx (eng)
- Python Documentation (generated using Sphinx)
- Sphinx Documentation Generator Guide (rus)