问题标签 [pydoc]

我知道如何从命令行使用 pydoc。但是，由于复杂的环境设置，最好在 python 脚本中将其作为本机 API 调用运行。也就是说，我的 python runner 看起来有点像这样：

导入 pydoc pydoc.generate_html_docs_for(someFile)

但是，从 pydoc 文档中我不清楚我需要使用哪个函数调用来使这种行为起作用。有任何想法吗？

寻找可以生成一组 Wiki 样式页面的 PyDoc 之类的东西，而不是从 PyDoc 导出的当前 HTML 页面。我希望能够将这些导出到 Google Code 的 Wiki 中，作为对当前文档的扩展。

有没有办法让 pydoc 的 writedocs() 函数为包创建子目录？例如，假设我有以下模块要记录：

当我运行 pydoc.writedocs() 时，我得到以下文件：

我想得到：

有没有办法做到这一点？

我有很多可调用对象，并且它们都__doc__正确填写了字符串，但是在它们上运行帮助会为他们的类生成帮助，而不是基于__doc__.

我想更改它，以便对它们运行帮助生成自定义帮助，如果它们是实际函数而不是实现__call__.

在代码中，我想输出以下内容：

看起来更像这样的输出：

object.__doc__除了在源代码中的文档本身前面添加一个“r”之外，有没有办法获取原始字符串？

我里面有乳胶代码，'\r's、'\f's 等正在产生问题。

在 Windows 和 python.org 2.6.4 下尝试使用 pydoc 时，出现以下错误：

这里有什么问题？

我最近下载了 IMDbpy 模块。当我这样做时，

我没有得到完整的文档..我必须做

查看可用的方法。我不喜欢这个控制台界面。有没有更好的阅读文档的方法。我的意思是一页中与模块 imdb 相关的所有文档。.

我目前正在将所有现有（不完整）文档迁移到Sphinx。

问题是文档使用Python 文档字符串（模块是用 C 编写的，但可能无关紧要）并且类文档必须转换为可用于 Sphinx 的形式。

有sphinx.ext.autodoc，但它会自动将当前文档字符串放入文档中。我想根据当前的文档字符串在 ( RST ) 中生成一个源文件，然后我可以手动对其进行编辑和改进。

您如何将文档字符串转换为 Sphinx 的 RST？

声明从特定类继承的类时：

类的文档C列出了dict（通过help(C)或pydoc）的所有方法。

有没有办法从自动生成的文档中隐藏继承的方法（文档字符串可以引用基类，用于非覆盖方法）？还是不可能？

这将很有用：在其类之后pydoc列出模块中定义的函数。因此，当类的文档很长时，会在模块提供的新功能出现之前打印出很多不太有用的信息，这使得文档更难被利用（您必须跳过所有继承方法的文档直到您达到特定于正在记录的模块的内容）。

一些 Python 模块（如math和sys）的 pydoc 文档有一个“模块文档”部分，其中包含指向一些 HTML 文档的有用链接：

这样的部分如何包含在您自己的模块中？

更一般地说，是否有记录 pydoc 识别的变量的地方？

我无法在源代码中找到它，因为该math模块是我的机器（OS X）上的共享库，并且该sys模块是用 Python 构建的……任何帮助将不胜感激！