Sphinx (documentation generator)

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Sphinx
Sphinx Python Documentation Logo.png
Developer(s) Georg Brandl
Initial release March 21, 2008 (2008-03-21)
Stable release 1.2.2[1] / March 2, 2014; 6 months ago (2014-03-02)
Preview release 1.3a0
Written in Python
Operating system Cross-platform
Type Documentation generator
License BSD
Website sphinx-doc.org

Sphinx is a documentation generator which converts reStructuredText files into HTML websites and other formats including PDF, EPub and man. It exploits the extensible nature of reStructuredText through a number of extensions (e.g. for autogenerating documentation from source code, writing mathematical notation or highlighting source code). The first public release, version 0.1.61611, was announced on March 21, 2008.[2] It was developed for, and used extensively by, the Python project for documentation.[3]

Since its introduction in 2008, Sphinx was adopted by many other important Python projects, such as Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django and Pylons; it is also used for the Blender Python API documentation.[4] In an effort to make maintenance of software documentation easier, the Read the Docs project was created.[5] It automates the process of building and uploading Sphinx documentation after every commit. It is sponsored by the Python Software Foundation.[6]

See also[edit]

References[edit]

  1. ^ "Changes in Sphinx". 
  2. ^ "Sphinx is released! » And now for something completely Pythonic...". And now for something completely Pythonic... Georg Brandl. Retrieved 2011-04-03. 
  3. ^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. Retrieved 2011-04-03. 
  4. ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Wiki. Blender Foundation. Retrieved 2011-04-06. 
  5. ^ "Announcing Read The Docs". Surfing in Kansas. Eric Holscher. Retrieved 2011-04-06. 
  6. ^ "Python Software Foundation News: PSF Funds readthedocs.org". Python Software Foundation News. Python Software Foundation. Retrieved 2011-04-06. 

External links[edit]