Sphinx (documentation generator)

Sphinx
Developer(s) Georg Brandl
Initial release March 21, 2008 (2008-03-21)
Stable release 1.3.1[1] / March 17, 2015 (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, heavily used (and written) by the Python community. It's also written in Python (a programming language); but used by many other environments.

Purpose and Function

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

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 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.

References

  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. ↑ "Announcing Read The Docs". Python Software Foundation News. Eric Holscher. Retrieved 2015-02-15.

External links


This article is issued from Wikipedia - version of the Tuesday, April 19, 2016. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.