https://github.com/jayvdb/sphinx-epytext

Sphinx "epytext" extension
https://github.com/jayvdb/sphinx-epytext

Last synced: 11 months ago
JSON representation

Sphinx "epytext" extension

• Host: GitHub
• URL: https://github.com/jayvdb/sphinx-epytext
• Owner: jayvdb
• License: mit
• Created: 2014-11-20T02:51:05.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2021-10-27T10:23:45.000Z (almost 5 years ago)
• Last Synced: 2025-08-25T00:42:18.761Z (12 months ago)
• Language: Python
• Size: 5.86 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
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

Configuration

-------------

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

    extensions = [

        'sphinx.ext.autodoc',

        'sphinx_epytext',

        # your other sphinx extensions

        # ...

    ]

Then run ``sphinx-build``.