It will help code developers in building nice interfaced documentation files for their projects.
It has various other usagesas a book index, project navigation or it can work as a website by itself.
It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects.
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.
Here are some key features of "Sphinx":
· Output formats: HTML (including Windows HTML Help), plain text and LaTeX, for printable PDF versions
· Extensive cross-references: semantic markup and automatic links for functions, classes, 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
· Various extensions are available, e.g. for automatic testing of snippets and inclusion of appropriately formatted docstrings.
Requirements:
· Pygments 1.2 or higher
· Jinja 2.3 or higher
· Docutils 0/7 or higher
What's New in This Release: [ read full changelog ]
· Fixed crash with some settings of :confval:`modindex_common_prefix`.
· Fixed handling of ``-D`` and ``-A`` options on Python 3.
· Recognized and warn about circular toctrees, instead of running into recursion errors.
· Restore compatibility with docutils trunk.
· Fixed HtmlHelp index entry links again.
· Fixed inheritance_diagram raising attribute errors on builtins.
· Fixed crashes when putting comments or lone terms in a glossary.
· Fixed HTML help language/encoding mapping for all Sphinx supported languages.
Find us on Google+
