跳过空模块 - Sphinx Autodoc

Question

我正在使用 Sphinx 为包构建文档。在构建文档时，我找不到跳过（删除）空子模块的方法。 Section 2 中的示例有一个名为 Submodule 的小节，它是空白的我想跳过这些小节。我尝试使用以下代码。

def skip_util_classes(app, what, name, obj, skip, options):
    if what == "Submodules":
        skip = True
    return skip


def setup(sphinx):
    sphinx.connect("autodoc-skip-member", skip_util_classes)

以上代码没有删除部分Submodules。

我想知道如何定义需要跳过的部分或小节？以及如何定义我想在 skip_util_classes 中跳过的空部分或小节？

Answer 1

当您希望 Sphinx 忽略 Python 模块或类的某些成员时，可以使用类似于 skip_util_classes 函数（autodoc-skip-member 事件的处理程序）的函数。参见 Connect Sphinx autodoc-skip-member to my function。

此技术不能用于跳过或删除生成的 .rst 文件中的部分。以下是可能有助于解决该问题的两个建议：

创建自定义 sphinx-apidoc 模板。参见。
不要运行 sphinx-apidoc 一遍又一遍。运行工具一次，调整输出并将其添加到源代码管理。参见。

跳过空模块 - Sphinx Autodoc

Skip Empty Modules - Sphinx Autodoc

python-3.x

python-sphinx

autodoc