Metadata-Version: 2.4
Name: sphinx-epytext
Version: 0.0.4
Summary: Sphinx "epytext" extension.
Home-page: https://github.com/jayvdb/sphinx-epytext
Download-URL: http://pypi.python.org/pypi/sphinx-epytext
Author: John Vandenberg
Author-email: jayvdb@gmail.com
License: MIT
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
License-File: LICENSE
Requires-Dist: sphinx>=0.4
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: download-url
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: platform
Dynamic: requires-dist
Dynamic: summary

Sphinx epytext support
======================

sphinx-epytext provides basic support for epytext docstrings
<http://epydoc.sourceforge.net/epytext.html> 
in Sphinx autodoc <http://sphinx-doc.org/ext/autodoc.html>. 

It connects to the 'autodoc-process-docstring' hook of Sphinx, to perform the following:

- Replaces '@' with ':' for epydoc fields. <http://epydoc.sourceforge.net/fields.html>
- Replaces L{..} and C{..} with :py:obj:`..`
- Removes U{..} from around links

Configuration
-------------

Add it to your extensions in ``conf.py``::

    extensions = [
        'sphinx.ext.autodoc',
        'sphinx_epytext',
        # your other sphinx extensions
        # ...
    ]

Then run ``sphinx-build``.
