Sphinx learning notes

So I am reading the other new thing Sphinix, and I met another new thing reStructuredText.  Sphinix is only released 5 years ago.  No wonder I have never heard of it.


Sphinx (documentation generator) - Wikipedia

Developer(s) Georg Brandl

Initial release March 21, 2008

Stable release 1.1.3[1] / March 10, 2012; 14 months ago

Preview release 1.2

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]


References

^ "Changes in Sphinx".

^ "Sphinx is released! » And now for something completely Pythonic...". And now for something completely Pythonic... Georg Brandl. Retrieved 2011-04-03.

^ "About these documents — Python v2.7.1 documentation". Python documentation. Python Software Foundation. Retrieved 2011-04-03.

^ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!". Blender Wiki. Blender Foundation. Retrieved 2011-04-06.

^ "Announcing Read The Docs". Surfing in Kansas. Eric Holscher. Retrieved 2011-04-06.

^ "Python Software Foundation News: PSF Funds readthedocs.org". Python Software Foundation

News. Python Software Foundation. Retrieved 2011-04-06.

External links

Official website

A list of projects using Sphinx

Python Documentation (generated using Sphinx)

.END