Sphinx logo

Download

Current version: 1.0.6

Get Sphinx from the Python Package Index, or install it with:

easy_install -U Sphinx

Latest development version docs are also available.

Questions? Suggestions?

Join the Google group:

or come to the #pocoo channel on FreeNode.

You can also open an issue at the tracker.

Welcome

What users say:

“Cheers for a great tool that actually makes programmers want to write documentation!”

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.

Documentation

You can also download PDF versions of the Sphinx documentation: a version generated from the LaTeX Sphinx produces, and a version generated by rst2pdf.

Examples

Links to documentation generated with Sphinx can be found on the Projects using Sphinx page.

For examples of how Sphinx source files look, use the “Show source” links on all pages of the documentation apart from this welcome page.

You may also be interested in the very nice tutorial on how to create a customized documentation using Sphinx written by the matplotlib developers.

There is a Japanese translation of this documentation, thanks to Yoshiki Shibukawa.

Get Sphinx

Sphinx is available as an easy-installable package on the Python Package Index.

The code can be found in a Mercurial repository, at http://bitbucket.org/birkenfeld/sphinx/.