From mn/geo/geoit
Jump to: navigation, search

Learn how to use sphinx!

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well. Of course, this site is also created from reStructuredText sources using Sphinx!

Sphinx is under constant development. The following features are present, work fine and can be seen “in action” in the Python docs:

   Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), manual pages, plain text
   Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
   Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
   Automatic indices: general index as well as a module index
   Code handling: automatic highlighting using the Pygments highlighter
   Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.