如何导出包的所有 Python 文档并将其放入 Devhelp？

Question

目前，要阅读包的文档，quickly例如，我这样做：

>>> import quickly
>>> help(quickly)
 
>>> import quickly.widgets
>>> help(quickly.widgets)
 
>>> import quickly.widgets.text_editor
>>> help(quickly.widgets.text_editor)
 

等等...

这显然是非常乏味的。如何导出所有快速文档，包括所有子包，然后让它显示在devhelp文档浏览器中？

将文档导出为 HTML 也很好。如果网络上存在它的某个版本，我什至会很高兴，但我似乎找不到一个。

注意：通过包我的意思是一个 蟒蛇包，不是 .deb 包。

Answer 1

您可以使用epydoc创建 Python 模块的 HTML 文档 .

Epydoc 是一种基于 Python 模块的文档字符串生成 API 文档的工具。

以下是如何使用epydoc为模块创建 HTML 文档quickly.widgets：

epydoc --html quickly.widgets -o quickly_widgets_doc

完成后，quickly_widgets_doc/index.html在您的网络浏览器中打开：

或者，如果您更喜欢 PDF 格式的文档：

epydoc --pdf quickly.widgets --name "quickly.widgets" -o quickly_widgets_doc_pdf

这将创建文件 quickly_widgets_doc_pdf/api.pdf

有关使用epydoc 此处的更多信息。

我还没有找到将这些转换为 DevHelp 可以使用的格式的方法，如果我这样做了，我将编辑此答案。

Answer 2

我鲜为人知的“秘密”是每个 Python 安装中都包含的pydoc 工具（因此无需安装额外的包）。

启动一个 Web 服务器，从源生成即时文档（使用与help()Python 控制台中相同的技术），并使用以下命令侦听http://localhost:8000/：

pydoc -p 8000

启动网络服务器和基于 Tkinter 的 GUI，提供搜索选项等：

pydoc -g

将quick.widgets的文档写入当前目录中的HTML文件quick.widgets.html：

pydoc -w quickly.widgets