使用pdoc来自不同模块的文档功能

Question

我有两个模块：

first_module包含函数a、b和c

second_module包含函数d、e和f

我希望使用生成一个文档，这样它不会完整地记录两个模块，而是只包含函数b、e和f。

有什么想法吗？

Answer 1

您可以在模块中使用__all__作为pdoc尊重它。

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

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

以及：

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