Skip to main content

Renders Python docstrings to rich HTML

Project description

Docrepr

Docrepr renders Python docstrings to HTML with Sphinx. It can generate rich and plain representations of docstrings, alongside additional metadata about the object to which the docstring belongs. It is based on the sphinxify module developed by Tim Dumol for the Sage Notebook and the utils.help module developed by Carlos Cordoba for the Spyder IDE. See spyder-ide/docrepr#20 for the full history.

Rationale

For more on the motivation and design behind Docrepr, see this presentation by Carlos Cordoba at SciPy 2015:

Towards a Better Documentation System for Scientific Python | SciPy 2015 | Carlos Cordoba

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 numpy as np
from IPython.core.oinspect import Inspector   # oinfo generator

import docrepr                                # Set module options
from docrepr import sphinxify                 # html generator

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 BSD 3-Clause License.

Download files

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

Source Distribution

docrepr-0.2.0.tar.gz (145.9 kB view details)

Uploaded Source

Built Distribution

docrepr-0.2.0-py3-none-any.whl (147.3 kB view details)

Uploaded Python 3

File details

Details for the file docrepr-0.2.0.tar.gz.

File metadata

  • Download URL: docrepr-0.2.0.tar.gz
  • Upload date:
  • Size: 145.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for docrepr-0.2.0.tar.gz
Algorithm Hash digest
SHA256 3ad62ecdaa0b7ab90dcd9c29abc98cae7d61d09339f18396d4ca5b8ab41c8b90
MD5 185efee28ffd4fb98088ed7d87ad086d
BLAKE2b-256 e59c09842655e1ac504cf1cbc78a35533d9d02f4245fa608ea8028c6aa18dc43

See more details on using hashes here.

Provenance

File details

Details for the file docrepr-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: docrepr-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 147.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/0.0.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for docrepr-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbee26975f939495a66eb54a3c45849b23eec370d3b89f3bcb6f1a7a6153d4a1
MD5 2fe9a670bb2bbbbf7ab82699d6ce06af
BLAKE2b-256 d717f6a000caccf0f84a9c5fed8989aad7260a970cd5efdcfeb04d4b52439bf5

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page