问题标签 [pydoc]

我正在使用 pydoc 模块来输出我用 C API 定义的某些类型的文档。在解释器嵌入到我的 C 程序中之前，我想要记录的类型不存在，所以我不能使用 pydoc 命令。

我让我的 C 代码调用一个执行以下操作的函数：

这可行，但会生成带有硬编码“文件：/”链接目标的 HTML 页面。有没有办法使用链接的相对路径？

（为更好地记录 C API 中定义的类型的方法加分）

我正在使用 PyDoc 从我的 Python 代码生成文档，我正在使用 Jira 的 Confluence 插件来管理文档。有什么方法可以生成 PyDoc 文档并将其放入 Confluence 中？

谷歌搜索没有产生太多结果。

感谢大家

这两件事有区别吗？两者在 Python 中给出的结果是相似的。

我是 python 开发新手并使用 Eclipse/Pydev。有没有一种很好的方法可以将用于生成文档的工具（例如 Sphinx、pydoc）集成到 IDE 中以拥有一个很好的工作流程，也许可以在单独的选项卡中显示文档？

是否有打印帮助（'myfun'）输出的选项。我看到的行为是输出被打印到 std.out 并且脚本等待用户输入（即输入“q”继续）。

必须有一个设置将其设置为仅转储文档字符串。

或者，如果我可以只转储文档字符串加上“def f(args):”行，那也可以。

搜索“python 帮助功能”很可笑。:) 也许我在某个地方错过了一些很好的 pydoc 页面来解释这一切？

PyDoc creates HTML documentation in current directory when generating documentation of modules. I really need to specify another directory which will be a placeholder for generated documentation instead the directory from which PyDoc is called.

I am using python -m pydoc -w <MODULES_DIR> to generate documentation.

Is this possible and if it is, how?

我有一个带有以下参数列表的函数：

不幸的是，该模块的 pydoc 帮助文本显示如下：

如何让 pydoc 给出文件参数file=sys.stdout而不是显示对象的血腥细节？

顺便说一句，Python 3.2。

Pydoc 可以为 Python 模块/函数/类生成很好的文档，以便从命令行读取。

这个工具javadoc似乎没有提供这样的功能。

我使用 Emacs 并希望能够在不离开 Emacs 的情况下快速获取有关标准 java 库的文档。

如果存在这样的实用程序，我可以集成到 Emacs...

我也认为从 Bash 中阅读 javadoc 很不错...

PS。例如，我希望实用程序从现有的 java 安装中提取文档而不指定它的路径（从JAVA_HOME或没有 javadoc.zip 的PATH仅来自所有JDK安装附带的 src.zip）...

Visual Studio 不在我的工作地点，我正在使用 Notepad++ 进行开发。我知道 MSDN，但我想像在 Python 中一样从命令行浏览文档。

在 Python 中，您可以浏览模块或函数的文档，或者像这样：

给

我想知道 C# 是否有类似的东西，我可以在其中执行以下操作：

我在 Console.ReadLine 方法上得到了一些帮助。

有没有办法做到这一点？

例子：

输出：

返回多项式除法的商和余数...

使用 pydoc 时：

我得到：

numpy.polydiv = polydiv(u, v)
返回多项式除法的商和余数...

是否有一些可用的属性可以让我polydiv(u, v)通过使用 python 脚本来获取函数声明部分（不使用 pydoc/终端）