sphinxcontrib.epydoc – Epydoc crossreferences

This Sphinx extension cross-references API documentation generated by epydoc. It works with the standard roles of the Python domain.

The extension is available under the terms of the BSD license, see LICENSE for more information.

Installation

The extension requires Sphinx 1.1 and Python 2.6. Python 3 is supported, too. It is available in the Python Package Index:

pip install sphinx-contrib.epydoc

Alternatively, you can clone the sphinx-contrib repository from BitBucket, and install the extension directly from the repository:

hg clone http://bitbucket.org/birkenfeld/sphinx-contrib
cd sphinx-contrib/epydoc
python setup.py install

Configuration

Add sphinxcontrib.epydoc to the configuration value extensions and setup an epydoc_mapping:

epydoc_mapping

A dictionary mapping URIs to a list of regular expression.

Each key of this dictionary is a base url of an epydoc-generated documentation. Each value is a list of regular expressions, the reference target must match (see re.match()) to be cross-referenced with the base url.

For instance, assume this value was set to the following:

epydoc_mapping = {
   'http://paludis.pioto.org/api/python/': [r'paludis(\.|$)'],
   }

Then the following cross-reference would link to the documentation of the paludis.PackageID class:

This is a cross-reference to the :class:`paludis.PackageID`

The group at the end of the pattern allows to reference the top-level paludis, too.

Contribution

Please contact the author or create an issue in the issue tracker of the sphinx-contrib repository, if you have found any bugs or miss some functionality (e.g. integration of some other issue tracker). Patches are welcome!