Metadata-Version: 1.0
Name: sphinxcontrib-epydoc
Version: 0.6
Summary: Epydoc cross-referencing for Sphinx
Home-page: http://packages.python.org/sphinxcontrib-epydoc
Author: Sebastian Wiesner
Author-email: lunaryorn@googlemail.com
License: BSD
Description: ####################
        sphinxcontrib-epydoc
        ####################
        
        .. image:: https://secure.travis-ci.org/lunaryorn/sphinxcontrib-epydoc.png
           :target: http://travis-ci.org/lunaryorn/sphinxcontrib-epydoc
        
        http://sphinxcontrib-epydoc.readthedocs.org
        
        A Sphinx_ extension to cross-reference API documentation generated with Epydoc_.
        
        
        Installation
        ------------
        
        This extension can be installed from the `Python Package Index`_::
        
           pip install sphinx-contrib.epydoc
        
        
        Usage
        -----
        
        Add this extension to ``extensions`` and configure the cross-reference mapping::
        
           extensions = ['sphinxcontrib.epydoc']
        
           epydoc_mapping = {
              'http://paludis.exherbo.org/api/python/': [r'paludis(\.|$)'],
           }
        
        Now you can reference identifiers from Paludis_ with the standard directives
        from the Python domain::
        
           This is a cross-reference to :class:`paludis.PackageID`.
        
        For more details refer to the documentation_, though there really isn't much
        more.
        
        
        .. _Epydoc: http://epydoc.sourceforge.net/
        .. _Sphinx: http://sphinx.pocoo.org/latest
        .. _documentation: http://sphinxcontrib-epydoc.readthedocs.org
        .. _python package index: http://pypi.python.org/pypi/sphinxcontrib-epydoc
        .. _paludis: http://paludis.exherbo.org/api/python/index.html
        
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
