我最近创建了一个 GitHub Actions 工作流来检查/重新格式化我的 repo 代码并使用pdoc创建文档 HTML 页面。 最后一步是有问题的，因为 pdoc 运行 .py 文件来创建文档。 对于其中一个文件 (file.py)，需要设置 ServiceNow ODBC 驱动程序，并且不 ...

我有两个文件： mainFile.py和test_mainFile.py 。 我正在尝试使用在命令行中运行良好的 pdoc 生成文档，但是当我尝试使用 GitHub Actions 执行相同的操作时，它找不到该文件。 我导入 mainFile.py 的 test_mainFile.py 如下所示： ...

我有一个 Python package 分布在多个文件中： thing_XXX将内部代码块分解成更易于管理的东西。 __init__.py文件在顶层和每个子模块中导出我想要的公共 API：from .thing_a import the_greatest_thing from .thing_b ...

Pdoc 在我的 pre-commit 钩子中最后被调用，它将文档构建到/docs ，它包含在我的存储库中。 /docs中的文件被排除在预提交挂钩之外，因此格式化挂钩不会触及它们。 我观察到以下模式： 我使用pre-commit run --all在本地运行预提交。 钩子过去了。 我 ...

我的代码目录如下所示。 我需要为 sub1、sub2、submoduleA1、submoduleB1 等所有模块生成文档。 也如 submoduleB2.py 所示：所有模块从其他模块/子模块导入 submoduleB2.py 的代码结构 我尝试使用 anaconda 提示符运行 pdoc 命令， ...

我正在尝试将 google-style 指令与 pdoc 一起使用，但它在我这边不起作用。 我哪里错了？ 下面是我的代码。 请帮我。 :) OUTPUT 做一点事 Args：a(str)：第一个参数。 b(str)：第二个参数。 返回： Set：返回值。 如果结果有值，则为字符串集，否则为空集 ...

我使用 pdoc3 通过执行以下命令从每个 python 类/函数开头的文档字符串自动生成文档 pdoc3 --html ambit_stochastics生成的文档可以在https://danleonte.github.io/Ambit_Stochastics/index.ZFC35FDC70D5 ...

我正在使用pdoc3来生成我的项目文档。 该项目由 2 个 py 模块组成： api.py 模型.py 数据结构在model.py 中定义并在api.py 中使用。 生成的 HTML 不会将函数参数生成为链接。 如何让 pdoc 生成函数 args（数据结构）作为链接？ == ...

从像 pdoc 这样的文档生成器中隐藏导入的正确方法是什么？ 具体来说，在临时脚本上生成文档的最佳实践是什么？ 例如： 需要在环境中安装一些someThirdPartyLibrary ，否则 pdoc 将失败。 选项似乎是： A. 将所有 3rd 方库安装到我正在运行 pdoc 的任何 ...

我会先说我仍然熟悉 Python。 我的代码执行得很好，没有错误。 我已经安装了我需要的所有软件包。 但是当我尝试使用pdoc --html <filename>为我的代码创建文档时，我收到了这个错误...... 这是我尝试在其上运行 pdoc 的文件开头的导入语句。 我认为这是路径问 ...

这是一个非常平的问题。 我正在使用 pdoc 为我的库创建一些文档，该库使用 PIL 进行图像处理。 一切正常，除了使用 PIL 的模块，它抛出了以下内容Traceback (most recent call last): File "/Library/Frameworks/Python.fr ...

我第一次通过 docstring 和 pdoc3 生成 html 文档。 我想替换显示的合格内部和外部链接的名称，例如我在 pdoc3 文档本身中看到的那样A special type of documentation object `pdoc.External` is used to... 生成此 ...

我正在尝试按照本文使用pdoc模块为我的 python 项目生成文档。 我注意到生成的文档中缺少以__ （私有/受保护的）开头的所有类、方法等。 这是sample.py 这就是我使用 pdoc 生成文档的方式 根据此屏幕截图，我在生成的文档中只看到 public class ： 有人可以帮我想办法 ...

如何为c_nested function 自动生成文档？ 背景：我为其他开发人员编写代码文档，我想自动生成所有 class 方法的摘要，包括带有简短描述（文档字符串）的嵌套函数。 当我在 class A上运行help(A)时，我得到：Help on class A in module __main ...

我试图使用 pdoc 为我的 python package 生成文档，当我运行命令py -m pdoc --html [package name]. 它输出错误...\Python\Python38\python.exe: No module named pdoc.__main__; 'pdoc' ...

我有两个模块： first_module包含函数a ， b和c second_module包含函数d ， e和f 我想使用pdoc生成HTML文档，这样它不会完整记录两个模块，而是仅包含函数b 、 e和f 。 有任何想法吗？ ...

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

我有一个脚本，它使用 pdoc 为我的项目中的所有类生成文档。 我想通过更改 pdoc 模板来进一步自定义我的文档。 我想在我的项目中执行此操作，以便我可以跟踪 git 中的更改，因此我需要更改 --template-dir。 这作为 cmd 行参数很容易，但是在 python 脚本中使用 pdoc ...

我不知道到底发生了什么，我对Pdoc没有那么了解，但我正在使用它来创建我的源代码的文档。 它通常工作得很好，但我最近在记录从enum.Enum继承的类时偶然发现了一个问题。 类文档工作得很好，但我添加到枚举中的每个类变量都包含它下面的整个文档。 有什么办法可以去掉这些吗？ ...

我正在尝试使用 pydoc 生成 HTML 文档。 该项目分为几个子文件夹，所有子文件夹都包含__init__.py文件。 我的主文件夹中__init__.py的内容如下： 我可以毫无问题地运行该应用程序。 子文件夹中的文件可以看到主文件夹中的文件，并且所有导入的模块都运行良好。 但是，pydoc ...