问题标签 [pdoc]

我正在尝试使用 pdoc 创建一个普通的 .html 文件，但我收到一条错误消息。

文件 1：gui.py

文件 2：start.py

我正在尝试执行：

python "C:\Python34\Scripts\pdoc" --html "C:\pathtothefile\script.py"

并得到消息：

gui.py 与 start.py 位于同一文件夹中。我如何告诉 pdoc 是这种情况？

我正在尝试使用 pdoc 生成文档，我的文档字符串如下所示：

我发现了这个问题：如何在使用 sphinx 生成 python 文档时保留换行符，但建议在每行前面加上 | 对我不起作用（它只是像这样出现）

在每行末尾使用 \n 的任何想法？

我正在使用 python 2.7 并尝试使用 pdoc 为我们的测试项目收集文档。

pdoc 位于此处：D:\dev\Python27\Scripts 此处的回归项目：C:\views\md_LDB_RegressionTests_v03.1_laptop\mts\Tests\LDB\Regression\Tests 我们正在使用 proboscis 进行测试，我正在尝试创建单独的一组测试的 html 文档，在我的例子中是一个单独的 python 文件。我运行这样的命令：

并得到这样的答案：

pdoc 无法从我们回归中的其他模块导入函数...我们项目的结构如下所示：

当然还有很多其他的包，但我不确定现在描述所有的结构是否有意义

check_capabilities_encoding_problems.py 的导入部分如下所示：

我如何指向 pdoc 在哪里寻找其他模块的功能？谢谢你！

我正在使用 pdoc 功能：

但根据http://pdoc.burntsushi.net/pdoc#pdoc.html上的文档，我无法找到如何导出与 CSS 分离的 HTML。

我准备了一个简单的代码，它使用pdoc模块从 Python（*.py 或 *.pyc）脚本创建一个 html 页面。代码如下：

我已经准备了几个带有文档的 html 页面，并想创建一个页面，其中包含指向我创建的所有 html 页面的链接。换句话说，我想创建类似于主 pdoc 文档页面的内容。

是否可以使用 pdoc 模块制作主页？

我正在pdoc为我的一个项目生成文档。这是我的文件结构-

..在哪里main_script.py导入script_one.py和其他一些库。并且__init__.py是空的。

从内部my_project/目录，我运行pdoc3 --html scripts并面临以下错误 -

ValueError: File or module 'scripts.main_script' not found

. . .

我运行pdoc3 --html scripts/main_script.py并面临以下错误 -

ImportError: Error importing 'scripts/script_one.py': No module named 'random_module'

. . .

从scripts/目录内部，当我运行时pdoc3 --html main_script.py，它会抛出一个导入错误，例如-

但是一旦我some_module从我的main_script.py.

这里有什么问题？

pdoc3 是一个从代码生成文档的好工具。在我的一个项目中，我遇到了一些例外。不知道是不是项目结构造成的。这些是我的两个项目的文件夹结构。

在 proj_B 的 utility.py 中，我必须从 project_A 导入一个类

在 proj_B 的 src 文件夹中运行 pdoc3 会导致以下错误。proj_A 已使用“sudo pip3 install proje_A.gz”安装

automation.connctl.core pdoc3 的代码中没有名为“automation.hl7ctl”的模块：

（见https://github.com/pdoc3/pdoc/blob/master/pdoc/init .py# L519）

这就是我运行 pdoc3 的方式：

有__init__.py自动化及其子文件夹，但没有“src”。

自动化/__init__.py具有以下内容：

我在我的 python 代码中的类上使用装饰器。我需要生成一些 xml，其中包含哪些类具有哪些装饰器，它们在哪个模块中，以及这些模块中的全局变量是什么。我已经尝试了所有主要的文档生成器，但甚至无法弄清楚哪个能够做到这一点。

• Doxygen (1.8.13-10)：生成的文档没有引用任何装饰器
• Sphinx：我什至无法让 sphinx 在我的模块上生成任何文档。我已经尝试了几个howtos，但自动模块似乎不起作用。
• pydoctor：我在带有自定义生成器类的 python2 项目中使用它，但不适用于 python3
• pdoc 有效，但没有装饰器，我看不到任何生成 xml 的方法
• pydoc3 只是说没有找到文档（因为没有评论，它是干净的代码）

一个最小的示例将包含以下树：

where__init__.py为空，ExampleService.py代码如下：

最后我会创建一个这样的xml（任何包含必要信息的东西都可以，我可以xslt）：

如果我生成一个带有python -m pdoc --html module.py输出的 html 页面，它将看起来像https://i.imgur.com/NmmW4Da.png

是否有一个参数可以以某种方式突出显示文档字符串中的 :param 条目？

我在一个类中定义了一个方法，如下所示：

pdoc 为该方法生成下图中的 HTML：

我需要做什么才能使 pdoc 为文档字符串的param和return部分生成不同的东西？似乎pdoc 会做一些事情来区分文档字符串中的参数和返回语句。这可能是参数和返回语句的亮点、斜体字体或粗体字体，如下所示。无论发生什么，我都希望看到文本:param并:return从文档字符串中删除：