Registered 2008-10-08 by Stuart Bishop

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation using reStructuredText markup.

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

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.

Although it is still under constant development, the following features are already present, work fine and can be seen “in action” in the Python docs:

    * Output formats: HTML (including Windows HTML Help) 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
    * Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules, 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.

Project information

Maintainer:
Stuart Bishop
Driver:
Not yet selected
Licence:
Simplified BSD Licence

RDF metadata

View full history Series and milestones

trunk series is the current focus of development.

All code Code

Version control system:
Bazaar
Programming languages:
Python

All packages Packages in Distributions

Get Involved

  • warning
    Report a bug
  • warning
    Ask a question
  • warning
    Help translate

Downloads

Sphinx does not have any download files registered with Launchpad.