Docrepr

Docrepr 将 Python 的文档字符串渲染成 HTML，使用 Sphinx。它可以为文档字符串生成丰富和纯文本表示，以及属于该文档字符串的对象的附加元数据。它基于由 Tim Dumol 为 Sage Notebook 开发的 sphinxify 模块和由 Carlos Cordoba 为 Spyder IDE 开发的 utils.help 模块。有关完整历史记录，请参阅 spyder-ide/docrepr#20。

原因

有关 Docrepr 的动机和设计，请参阅 Carlos Cordoba 在 SciPy 2015 上的这次演讲。

详细信息

该模块使用其 sphinxify 子模块的 rich_repr 函数，将 IPython oinspect 模块返回的字典渲染成包含所有资源的完整 HTML 页面。

使用示例

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)

许可证

本项目根据 BSD 3-Clause License 许可证分发。