docrepr
renders Python docstrings in HTML. It is based on the sphinxify module
developed by Tim Dumol for the Sage Notebook and the utils.inspector developed
for ther Spyder IDE.
Video presentation @ SciPy 2015 by Carlos Cordoba:
The module renders a dictionary as returned by IPython oinspect
module and
exports two functions: sphinxify
which uses Sphinx to render docstrings,
and rich_repr
that generates full HTML page (with all assets) from
IPython.core.oinspect
output and returns a URL to it.
Example:
>>> import docrepr, IPython
>>> myset = set()
>>> oinfo = IPython.core.oinspect.Inspector().info(myset, oname='myset')
>>> docrepr.sphinxify.rich_repr(oinfo)
c:\users\user\appdata\local\temp\docrepr\tmpwvoj3s\rich_repr_output.html
This project is distributed under the under the terms of the Modified BSD License