Skip to main content

Sphinx "epytext" extension.

Project description

Sphinx epytext support

sphinx-epytext provides basic support for epytext docstrings
in Sphinx autodoc <>.

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

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


Add it to your extensions in ````::

extensions = [
# 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.

Source Distribution

sphinx-epytext-0.0.4.tar.gz (3.6 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page