Sphinx (software)

from Wikipedia, the free encyclopedia
sphinx
Basic data

developer Georg Brandl
Publishing year March 2008
Current  version 1.6.7
( February 4, 2018 )
operating system cross-platform
programming language python
category Software documentation tool
License BSD
sphinx-doc.org

Sphinx is a software documentation tool that converts reStructuredText into HTML pages and many other formats such as PDF , EPUB and man pages . It uses the expandability of reStructuredText for e.g. B. the automatic generation of documentation from source text , the representation of mathematical notation or for syntax highlighting. The first public release was released on March 21, 2008. It was developed to document the Python project and is used extensively by them.

Since its introduction in 2008, Sphinx has been increasingly used in other important Python-based projects such as Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django and Pylons , and it is also used to document the Blender Python programming interface. To simplify the maintenance of software documentation, the read-the-docs project was founded, which automates the process of uploading the current documentation after each commit. The Python Software Foundation sponsors the Read-the-docs project.

literature

  • Jan Ulrich Hasecke, Georg Brandl: Software documentation with Sphinx. CreateSpace Independent Publishing Platform. 2014, ISBN 978-1-4974-4868-1 .

Web links

Individual evidence

  1. raw.githubusercontent.com .
  2. www.sphinx-doc.org .
  3. Georg Brandl: Sphinx is released! »And now for something completely Pythonic ... Retrieved April 3, 2011 .
  4. About these documents - Python v2.7.1 documentation. Python Software Foundation, accessed April 3, 2011 .
  5. Dev: 2.5 / Py / API / Generating API Reference - BlenderWiki! (No longer available online.) Blender Foundation, archived from the original on January 26, 2013 ; Retrieved April 6, 2011 . Info: The archive link was inserted automatically and has not yet been checked. Please check the original and archive link according to the instructions and then remove this notice. @1@ 2Template: Webachiv / IABot / wiki.blender.org
  6. Eric Holscher: Announcing Read The Docs. August 16, 2010, accessed April 6, 2011 .
  7. PSF Funds readthedocs.org. Python Software Foundation, March 9, 2011, accessed April 6, 2011 .