使用pydoc为私有函数生成文档

Question

我正在使用pdoc这个工具来根据Python文件生成HTML文档。不过，像_example_method这样的私有方法并没有被包含在文档里。我尝试过在pdoc命令中使用--all-modules，或者设置环境变量export PODOC_ALL_SUBMODULES=true。但是这些方法都没有奏效，所以我在想还有没有其他办法能让我得到想要的结果。

Answer 1

pdoc这个工具没有提供一个内置的选项来记录所有私有方法，因为私有方法不应该出现在你的公共接口中，也就是说，它们不应该出现在文档里。如果你觉得这样不对，你可以通过一个自定义模块模板来改变pdoc的默认行为。

https://pdoc.dev/docs/pdoc.html#control-what-is-documented是一本详细说明如何控制可见性的官方文档。