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``.
======================
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``.
1 maintainer
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 details)
File details
Details for the file sphinx-epytext-0.0.4.tar.gz.
File metadata
- Download URL: sphinx-epytext-0.0.4.tar.gz
- Upload date:
- Size: 3.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4cc5ba92693ee8853d841c03db434606275506bb418da5bb7538766c696d5e30
|
|
| MD5 |
5a7850b097af91ce495a6898fc4cbbe7
|
|
| BLAKE2b-256 |
a2d160a763434d39552b4a392c409ba769accbe9ad96b7227f66bc7a08129fcf
|
