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

Question

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

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

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

Answer 1

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