Skip to content

jayvdb/sphinx-epytext

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 

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:

Configuration

Add it to your extensions in conf.py:

extensions = [
    'sphinx.ext.autodoc',
    'sphinx_epytext',
    # your other sphinx extensions
    # ...
]

Then run sphinx-build.