问题标签 [pdoc]

我正在尝试使用 pdoc 来记录我的 python 脚本，但由于我的程序需要使用命令行参数，所以我遇到了问题。

我的程序调用如下：myprogram.py -p arg1 -s arg2

我尝试按如下方式运行 pdoc：pdoc --html myprogram

但我得到一个错误说pdoc: error: the following arguments are required: -p

但是，如果我尝试像这样运行 pdoc: pdoc --html myprogram.py -p arg1 -s arg2，我会收到此错误：

pdoc: error: unrecognized arguments: -p arg1 -s arg2

有没有办法在需要命令行参数的模块上运行 pdoc？

我正在尝试使用 pydoc 生成 HTML 文档。该项目分为几个子文件夹，所有子文件夹都包含__init__.py文件。

我的主文件夹中的内容__init__.py如下：

我可以毫无问题地运行该应用程序。子文件夹中的文件可以看到主文件夹中的文件，并且所有导入的模块都运行良好。

但是，pydoc 给我带来了问题。如果我尝试在子文件夹中的文件上使用它，他们将看不到主文件夹中的文件。

此外，没有看到已安装的模块。例如，pydoc -w在我的 ftp_operations 文件（位于主文件夹中）上运行说它找不到 Paramiko，它在应用程序中运行得很好。

我见过一些类似的问题，但大多数答案都是关于添加__init__.py我已经拥有的文件。我也尝试了 pdoc3，结果相同。我究竟做错了什么？我正在使用 Python 3.7。

提前致谢！

我不知道到底发生了什么，我对它的理解不是很好，Pdoc但我正在使用它来创建我的源代码的文档。它通常工作得很好，但我最近在记录继承自enum.Enum. 类文档工作得很好，但是我添加到枚举中的每个类变量都包含它下面的整个文档。

有什么办法可以去掉这些吗？

我们目前使用 GitHub 作为我们的代码库，其中包括用于文档的 HTML 文件。在 GitHub 上，repo 中的 HTML 文件仅显示 HTML 源，但我可以将其发布到 GitHub Pages，在那里它显示为我的用户的常规网页。

我们刚刚开始迁移到我组织内托管的 BitBucket。看起来 BitBucket Pages 插件相当于 GitHub Pages，但我们没有那个插件，我也不希望得到它。如果没有那个插件，有没有办法将 HTML 文件显示为网页？我们还有 JIRA 和 Confluence，以防万一。

我目前使用 pdoc (pdoc3) 记录我的 Python 代码以创建 HTML 文档。我不认为这个问题是 Python 或 pdoc3 特有的，但我只是想补充一下，以防万一。（我喜欢 pdoc3，但如果其他工具解决了我的问题，我会尝试一下。）

简而言之，如何在没有 Pages 插件的情况下在 BitBucket 中显示 HTML？

我有一个脚本，它使用 pdoc 为我项目中的所有类生成文档。我想通过更改 pdoc 模板来进一步定制我的文档。我想在我的项目中执行此操作，以便我可以跟踪 git 中的更改，因此我需要更改 --template-dir。作为 cmd 行参数，这很容易，但在 python 脚本中使用 pdoc 时，我无法进行此更改。我的问题是我可以在哪里传递这个参数，或者如果我创建一个 pdoc 对象，是否有一个函数或参数来进行这个更改。提前致谢！

我试图从 python 文档字符串创建文档，并找到了 pdoc。如果您不知道，它会从 python 文档字符串创建 html 文档。由于它生成.html文件而不是生成文件.rst，我如何将它们发布到 ReadTheDocs 或.rst使用 pdoc 生成文件？

快速旁注：我不想使用 sphinx，因为 1）pdoc 的主题非常酷，2）我不知道如何使用 sphinx 从文档字符串生成文档（我看过的所有教程都没有帮助）。

我有两个模块：

first_module包含函数a，b和c

second_module包含函数d，e和f

我想使用这样的方式生成一个HTML文档pdoc，它不会完整记录两个模块，而是仅包含函数b、e和f.

有任何想法吗？

我试图使用 pdoc 为我的 python 包生成文档，但是当我运行命令时它没有生成任何文档py -m pdoc --html [package name].它输出错误...\Python\Python38\python.exe: No module named pdoc.__main__; 'pdoc' is a package and cannot be directly executed为什么会这样？

如何为c_nested函数自动生成文档？

背景：我为其他开发人员编写代码文档，我想自动生成所有类方法的摘要，包括带有简短描述（文档字符串）的嵌套函数。

当我help(A)在课堂上跑步时，A我得到：

请求的输出：c_nested()带有文档字符串：（文档可以使用脚本打印事件，不需要使用 pydoc 帮助打印。）

类示例：

我正在尝试按照本文为我的带有模块的 python 项目生成pdoc文档。

我注意到__生成的文档中缺少以（私有/受保护的）开头的所有类、方法等。

这是sample.py

这就是我使用 pdoc 生成文档的方式

根据此屏幕截图，我在生成的文档中只看到公共类：

有人可以帮我想办法克服这个限制并与所有私人/受保护成员一起生成文档吗？提前致谢。