Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!
Project Description

About

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 module developed for the Spyder IDE.

Rationale

Video presentation @ SciPy 2015 by Carlos Cordoba:

Towards a Better Documentation System for Scientific Python

Details

The module renders a dictionary as returned by IPython oinspect module into a full HTML page (with all assets) from an object’s docstring, by using the rich_repr function of its sphinxify submodule.

Example of use

import webbrowser

import docrepr                                # Set module options
from docrepr import sphinxify                 # html generator
from IPython.core.oinspect import Inspector   # oinfo generator

import numpy as np

oinfo = Inspector().info(np.sin)
oinfo['name'] = 'sin'
url = sphinxify.rich_repr(oinfo)

webbrowser.open_new_tab(url)

License

This project is distributed under the under the terms of the Modified BSD License

Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
docrepr-0.1.0-py2.py3-none-any.whl (150.3 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Mar 7, 2016
docrepr-0.1.0.tar.gz (143.9 kB) Copy SHA256 Checksum SHA256 Source Mar 7, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting