README for sphinx-contrib

This repository contains a collection of Sphinx extensions maintained by their respective authors. It is not an official part of Sphinx.

Installing

Use setup.py in the subdirectory for the individual extension:

cd dir
python setup.py build
sudo python setup.py install

Contributing

If you want to add your own extension, please write an e-mail to [email protected] and give your bitbucket user name; you will then get write access to the public repo at http://bitbucket.org/birkenfeld/sphinx-contrib.

Send wishes, comments, patches, etc. for individual extensions to their author as given in the module.

List of extensions

• aafig: render embeded ASCII art as nice images using aafigure.
• actdiag: embed activity diagrams by using actdiag
• adadomain: an extension for Ada support (Sphinx 1.0 needed)
• ansi: parse ANSI color sequences inside documents
• autorun: Execute code in a runblock directive.
• blockdiag: embed block diagrams by using blockdiag
• cheeseshop: easily link to PyPI packages
• context: a builder for ConTeXt.
• doxylink: Link to external Doxygen-generated HTML documentation
• epydoc: cross-reference eypdoc generated documentation
• erlangdomain: an extension for Erlang support (Sphinx 1.0 needed)
• exceltable: embed Excel spreadsheets into documents using exceltable
• feed: an extension for creating syndication feeds and time-based overviews from your site content
• gnuplot: produces images using gnuplot language.
• googleanalytics: track html visitors statistics
• googlechart: embed charts by using Google Chart_
• httpdomain: a domain for documenting RESTful HTTP APIs.
• hyphenator: client-side hyphenation of HTML using hyphenator
• issuetracker: link to different issue trackers
• lilypond: an extension inserting music scripts from Lilypond in PNG format.
• mscgen: embed mscgen-formatted MSC (Message Sequence Chart)s.
• nicoviceo: embed videos from nicovideo
• nwdiag: embed network diagrams by using nwdiag
• omegat: support tools to collaborate with OmegaT (Sphinx 1.1 needed)
• osaka: convert standard Japanese doc to Osaka dialect (it is joke extension)
• paverutils: an alternate integration of Sphinx with Paver.
• plantuml: embed UML diagram by using PlantUML
• programoutput: include output of programs into documentation
• requirements: declare requirements wherever you need (e.g. in test docstrings), mark statuses and collect them in a single list
• rubydomain: an extension for Ruby support (Sphinx 1.0 needed)
• sadisplay: display SqlAlchemy model sadisplay
• sdedit: an extension inserting sequence diagram by using Quick Sequence. Diagram Editor (sdedit)
• seqdiag: embed sequence diagrams by using seqdiag
• spelling: Spelling checker using PyEnchant
• sword: an extension inserting Bible verses from Sword.
• traclinks: create TracLinks to a Trac instance from within Sphinx
• youtube: embed videos from YouTube
• zopeext: provide an autointerface directive for using Zope interfaces.
• clearquest: create tables from ClearQuest queries.

For contributors

When adding or updating your extension, please adhere to these guidelines:

• Use make-ext.py to set up your extension subdirectory.
• Each extension must be either a submodule or subpackage of the sphinxcontrib package. The sphinxcontrib/__init__.py file in your package must not be changed.
• Each extension must be listed in this file under "List of extensions" above.
• Each author should be listed in AUTHORS along with the extension name.
• It would be good to have all extensions BSD licensed; otherwise make a note in an ext/LICENSE file.
• Each extension can maintain a changelog and readme file; these files should be called ext/CHANGES and ext/README, respectively.