为 python 定制 pdoc 自动生成的文档答案

【问题标题】：customising pdoc automatically generated documentation for python为 python 定制 pdoc 自动生成的文档
【发布时间】：2022-01-17 15:49:06
【问题描述】：

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

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

找到

我可以从索引页面上的ambit_stochastics.helpers 中删除ambit_stochastics，然后再删除所有子页面上的ambit_stochastics 吗？这似乎没有必要而且冗长。
我可以编辑索引页面（访问链接时弹出的页面）以添加一些介绍性文字吗？其他模板呢？

【问题讨论】：

标签： python html documentation documentation-generation pdoc

【解决方案1】：

在不编辑模板的情况下不确定您的 #1 点，但您可以通过在 ambit_stochastics/__init__.py like pdoc does 中包含模块文档字符串来解决 #2。这十个呈现在主模块页面上，以及标题的 TOC： https://pdoc3.github.io/pdoc/doc/pdoc/

【讨论】：