Sphinx (documentation generator)

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

Sphinx is a documentation generator for the Python programming language.

Purpose and Function[edit]

Sphinx converts reStructuredText files into HTML websites and other formats including PDF, EPub 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[edit]

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 has been adopted by many other important Python projects, including Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django and Pylons. It is also used for the Blender user manual [4] and Python API documentation.[5]

In 2011, the Python Software Foundation.[6] created the Read the Docs project as part of an effort to make maintenance of software documentation easier.[7] Read the Docs automates the process of building and uploading Sphinx documentation after every commit.

See also[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. ^ "Blender User Manual". Blender Wiki. Blender Foundation. 
  5. ^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Foundation. Blender Foundation. 
  6. ^ "Python Software Foundation News: PSF Funds readthedocs.org". Python Software Foundation News. Python Software Foundation. Retrieved 2011-04-06. 
  7. ^ "Announcing Read The Docs". Surfing in Kansas. Eric Holscher. Retrieved 2011-04-06. 

External links[edit]