Sphinx 文档 - 排除层次结构中所有模块的 class 变量

Question

我正在尝试从我的 Sphinx 文档中删除所有 class 变量（因为我没有记录它们，如果只有它们的列表，它看起来不太好）我项目的所有类，包括文件夹中的模块. 有没有一种简单的方法可以做到这一点而不必排除其中的每一个？

PS：我是这方面的初学者，所以答案可能很简单。 此外，这已经可以回答，但我找不到任何东西。

Answer 1

您可以使用:no-undoc-members:告诉 sphinx 忽略未记录的（在您的情况下为类）变量。

:undoc-members: (no value)
    If set, autodoc will also generate document for the members not having docstrings:

这是文档 - https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#directive-option-automodule-undoc-members