1

正如这篇文章所描述的,即使拿破仑将字段作为文档添加到以下位置,autodoc 也会急切地将类变量添加到文档中:

from dataclasses import dataclass
@dataclass
class Foo():
    """Some class

    Attributes:
        a: foo
        b: bar
    """
    a: str
    b: int

    def c(self) -> int:
        """Here's a doc'd function
        """
        return 3

我想明确告诉 autodoc 不要记录任何类变量(在数据类的情况下也是实例变量) - 我只希望 autodoc 显示给定类的声明函数,并让拿破仑处理它的所有类的类/实例变量发现. 如果没有:exclude-members:每个班级,这可能吗(这是一个巨大的麻烦)?

我已经尝试过:

autodoc_default_options = {
    'members':          True,
    'undoc-members':    False,
}

在我的conf.py和这个.rst文件中:

.. automodule:: some.module
    :members:
    :show-inheritance:

这应该隐藏无证成员,但他们仍然出现:

在此处输入图像描述

4

0 回答 0