birkenfeld / sphinx (http://sphinx.pocoo.org/)
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.
$ hg clone http://bitbucket.org/birkenfeld/sphinx/
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.
Resources
The homepage and documentation can be found at http://sphinx.pocoo.org/.
The user and development mailing list is http://groups.google.com/group/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
- autosummary -- generate summary listings
- phantom_import -- import a fake module autodoc from an XML description
- traitsdoc -- extract documentation from Traits attributes
- numpydoc -- make autodoc understand Numpy docstring format
Packages on PyPI
- SphinxBuilder (http://pypi.python.org/pypi/collective.recipe.sphinxbuilder): buildout recipe that makes wirting documentation with Sphinx easier.
- IncludeDoc (http://pypi.python.org/pypi/collective.sphinx.includedoc): including existing doctest from other packages
- AutoATSchema (http://pypi.python.org/pypi/collective.sphinx.autoatschema): documenting Archetypes schemas
- SphinxReport (http://pypi.python.org/pypi/SphinxReport): a report generator based on Sphinx and matplotlib
This revision is from 2009-06-17 11:41