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
Metadata
1 maintainer
Release files for sphinx-epytext 0.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-epytext-0.0.4.tar.gz | 3.6 kB | Details |
Release files / sphinx-epytext-0.0.4.tar.gz
| Download URL | sphinx-epytext-0.0.4.tar.gz |
|---|---|
| Size | 3.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4cc5ba92693ee8853d841c03db434606275506bb418da5bb7538766c696d5e30
|
|
BLAKE2b-256 checksum How to use checksums |
a2d160a763434d39552b4a392c409ba769accbe9ad96b7227f66bc7a08129fcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
