主页 / ubuntu / 问题 / 16651
Accepted
Stefano Palazzo
Asked: 2010-12-09 08:08:26 +0800 CST

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

  • 772

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

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

等等...

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

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

注意：包是指替代文字 python-package，而不是 .deb 包。

programming python documentation

2 个回答

  1. Best Answer

    您可以使用epydoc 创建 Python 模块的 HTML 文档安装 epydoc。

    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 可以使用的格式的方法，如果我这样做了，我会编辑这个答案。

    • 6

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

    启动一个网络服务器，它从源代码生成即时文档（使用与 Python 控制台中相同的技术），该服务器在http://localhost:8000/help()上侦听：

    pydoc -p 8000

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

    pydoc -g

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

    pydoc -w quickly.widgets
    • 5

相关问题