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.

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

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page