What is Sphinx?

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. 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.

Build Status


The homepage and documentation can be found at http://sphinx-doc.org/.

The general mailing list is sphinx-users (Google Groups); discussions about the development of Sphinx take place in sphinx-dev. You're welcome to post any wish, problem or patch there.

The issue tracker on this site can be used to report bugs.

How to get it

The main distribution is hosted in a Mercurial (hg) repository at BitBucket, use this to get a clone:

hg clone http://bitbucket.org/birkenfeld/sphinx

You can also download a copy of the repository by using BitBucket's "download" link at the top left of the overview page.

To install the copy in a way that allows you to update it every now and then, use

sudo python setup.py develop

which will install a link to the checkout in your site-packages directory.

To view the repository over the web, visit the source browser.

Sphinx Extensions

  • Extensions from Numpy

    • phantom_import -- import a fake module autodoc from an XML description
    • traitsdoc -- extract documentation from Traits attributes
    • numpydoc -- make autodoc understand Numpy docstring format
  • Extensions from matplotlib

    • mathmpl -- render mathematical equations (alternative to sphinx.ext.pngmath and sphinx.ext.jsmath)
    • only_directives
    • plot_directive -- insert matplotlib plots

Packages on PyPI


Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.