Sphinx (documentation generator)

From Infogalactic: the planetary knowledge core
Jump to: navigation, search

Lua error in Module:Infobox at line 314: malformed pattern (missing ']'). 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

<templatestyles src="Reflist/styles.css" />

Cite error: Invalid <references> tag; parameter "group" is allowed only.

Use <references />, or <references group="..." />

External links

  • Lua error in package.lua at line 80: module 'strict' not found.
  • Lua error in package.lua at line 80: module 'strict' not found.
  • Lua error in package.lua at line 80: module 'strict' not found.
  • Lua error in package.lua at line 80: module 'strict' not found.
  • Lua error in package.lua at line 80: module 'strict' not found.
  • Lua error in package.lua at line 80: module 'strict' not found.