Skip to main content

Sphinx "epytext" extension.

Project description

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``.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-epytext, version 0.0.4
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-epytext-0.0.4.tar.gz (3.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page