问题标签 [pdoc]

我第一次通过 docstring 和 pdoc3 生成 html 文档。

我想替换显示的合格内部和外部链接的名称，例如我在 pdoc3 文档本身中看到的那样

A special type of documentation object `pdoc.External` is used to...

生成此文本，其中“外部”是一个链接。

“一种特殊类型的文档对象 External 用于...”

当我执行相同的操作时，pdoc.External 会显示在 html 文本中。

我想为我的内部链接执行此操作，并引用一些外部资源，例如 package.module.functionname，我希望文本仅为函数名并链接到我提供的外部网页，如 numpy 或 scipy 文档。

提前致谢

这是一个非常平的问题。我正在使用 pdoc 为我的库创建一些文档，该库使用 PIL 进行图像处理。一切正常，除了使用 PIL 的模块，它抛出了以下内容

尽管我运行了一次，但它多次抛出了那个确切的异常。只是为了检查，我用过pip3.9 show PIL，它说WARNING: Package(s) not found: PIL。但是，我在 PyCharm 中多次使用 PIL.Image，总是使用 python 3.9，就像我用于这个库一样。我往里看，/Library/Frameworks/Python.framework/Versions/3.9/lib/python3.9/site-packages在那里发现了 PIL。然后我确保该站点包路径位于 中sys.path，并且确实如此。我尝试使用 Pillow（PIL 的一个分支），并确保我有一个与 python3.9 兼容的版本（我有 8.1）。但是，即使我通过 PyCharmpip3.9 install Pillow和pip3.9 install pillow. pip3.9 show Pillow并pip3.9 show pillow说它存在并且有正确的版本。但是，PyCharm 仍然表现得像没有安装一样，并抛出ModuleNotFoundError: No module named 'Pillow'. 我也了解到 PIL 和枕头不能在同一个环境中，所以我尝试pip3.9 uninstall PIL了，但 pip 认为包从一开始就不存在。在我看来，我有 2 个选项：获取 pdoc 和 pip 以识别 PIL，或获取 Python 以识别 Pillow。我该怎么做，还是有其他选择？提前致谢，如果您需要更多信息，请告诉我！

更新：

我使用给出的答案中的命令创建了一个 venv，然后我找到了名为 activate 的文件，用于 venv（无扩展名），并在终端中输入以下内容：source path-to-activate，此时 venv 的名称出现在开头后面的括号中每个新的终端线。然后我进入 PyCharm 的解释器设置并在 PyCharm 上创建了一个新环境，选择“现有环境”，然后放入 venv 文件夹/bin/python3.9 的路径（这是指向真正 python3.9 的别名） . 它以它所在的项目命名该设置。我在解释器选项中切换到该设置。然后我跑了pip3.9 install pillow来自终端（仍在使用 venv），同时使用 pip 和 pip3.9 并用新 venv 中的路径替换它们。每次我收到要求已经满足的消息时，都会确保安装了枕头。我还检查了站点包，PIL 和 Pillow-dist-info 都在那里。PyCharm 没有出错，所以它工作正常。但是，当我运行时pdoc path-to-library-folder（仍在 venv 中），它抛出了完全相同的错误。我做错了什么吗？

我正在为一个项目创建文档，但在针对我的模块运行pydoc3时遇到了一个奇怪的错误。SQLAlchemydatabase

背景

项目布局：

生成文档的命令：模块的名称在
哪里...MODULE

问题：

我能够为每个模块生成文档，一次一个，没有问题。
（例如python3 venv/bin/pdoc3 --html --output-dir docs database：）

但是当我尝试为整个项目( MODULE='.') 生成文档时，我收到以下错误：

ImportError：导入“PROJECT_NAME.database”时出错：

InvalidRequestError：已经为此 MetaData 实例定义了表“FooBar”。指定 'extend_existing=True' 以重新定义现有 Table 对象上的选项和列。

这个错误的奇怪之处在于我有一个完整的测试套件，完全没有问题。此外，发生的错误database.__init__.py对我来说根本没有意义。

尽可能的解决方案：

我的想法是我的问题来自我如何配置我的declarative base...

内容database.__init__.py：

内容database.metadata.py：

内容database.models.base.py：

内容database.models.model.py：

从根调用时，pydoc 是否有可能尝试创建我的模型两次？

我在这里完全不知所措，不确定使用什么资源来进一步调查。

更新：

按照这个答案作为 inspa，如果我更新 , 的格式database.__init__.py，pdoc3则能够解析我的数据库模块，但是，不是database.models （我明确转义，因为完成比完美更好）。

修改database.__init__.py

我会先说我仍然熟悉 Python。我的代码执行得很好，没有错误。我已经安装了我需要的所有软件包。但是，当我尝试使用 为我的代码创建文档时pdoc --html <filename>，我收到此错误...

这是我尝试在其上运行 pdoc 的文件开头的导入语句。

我认为这是路径问题，我需要对我的 PYTHONPATH 变量做一些事情，但我不确定。任何帮助将非常感激

应该如何使用 Google 样式的文档字符串来记录参数或返回类型旨在成为特定类型的子类？

这就是我在使用类型提示时建议子类的方式。

假设上述内容是合理的，那么我如何在文档字符串中类似地记录这一点？

从像 pdoc 这样的文档生成器中隐藏导入的正确方法是什么？

具体来说，在临时脚本上生成文档的最佳实践是什么？

例如：

需要someThirdPartyLibrary在环境中安装，否则 pdoc 将失败。

选项似乎是：

A. 将所有 3rd 方库安装到我正在运行 pdoc 的任何环境中。这似乎完全没有必要，因为 pdoc 不需要实际运行代码只加载它。

B. 在 main 中隐藏导入并违反 PEP8

C. 比 A 和 B 更好的最佳实践？

我正在使用pdoc3来生成我的项目文档。该项目由 2 个 py 模块组成：

• api.py
• 模型.py

数据结构在 model.py 中定义并在 api.py 中使用。

生成的 HTML 不会将函数参数生成为链接。

如何使 pdoc 生成函数 args（数据结构）作为链接？

==代码片段==

api.py

模型.py

生成的 HTML

假设我有两个功能：

我认为很明显这种情况出现在编程中，出于显而易见的原因，复制粘贴不是一种选择。然后我的问题是，专门针对pdoc（谷歌风格的文档字符串），我如何passed_parameter在func_a. 我的第一个想法就是写作

这很好，但我想知道是否有更首选的方式来执行此操作pdoc，或者在PEP. 我尝试了类似“See func_b.passed_parameter”的方法，但这并没有超链接到pdoc.

我使用 pdoc3 通过执行以下命令从每个 python 类/函数开头的文档字符串自动生成文档

pdoc3 --html ambit_stochastics 生成的文档可以在https://danleonte.github.io/Ambit_Stochastics/index.html找到

1. 我可以ambit_stochastics从ambit_stochastics.helpers索引页面上删除，然后在所有子页面上删除吗？这似乎是不必要的和罗嗦的。
2. 我可以编辑索引页面（访问链接时弹出的页面）以添加一些介绍性文字吗？其他模板呢？

我正在尝试将 google-style 指令与 pdoc 一起使用，但它在我这边不起作用。我哪里错了？下面是我的代码。请帮我。:)

输出

做一点事

Args：a(str)：第一个参数。b(str)：第二个参数。

返回： Set：返回值。如果结果有值，则为字符串集，否则为空集。