python - 使用 pdoc 记录来自不同模块的函数

Question

我有两个模块：

first_module包含函数a，b和c

second_module包含函数d，e和f

我想使用这样的方式生成一个HTML文档pdoc，它不会完整记录两个模块，而是仅包含函数b、e和f.

有任何想法吗？

Answer 1

您可以在您的模块中声明，因为__all__pdoc 尊重它。

您可以在每个模块中使用__pdoc__dict覆盖一些文档字符串：

# first_module.py:
___pdoc___ = {
    'a': False,
    'c': False,
}

和：

# second_module.py:
___pdoc___ = {
    'd': False,
}