sphinx 文档将一个基类排除在 :inherited-members 中。

Question

我正在用Sphinx记录一些有多层继承的Python代码。 结构大致是这样的。

class _foo(np.ndarray):
    #do _foo stuff

class bar(_foo):
    #do bar stuff

class baz(_foo):
    #do baz stuff

在我的.rst文件中使用 :inheredited-members: 我得到的文档来自于 _foo 属于 bar 和 baz 但我也从 np.ndarray这是我不想要的。

Sphinx的文档(https:/www.sphinx-doc.orgenmasterusageextensionsautodoc.html)说。

例如；如果你的类Foo是从list类派生出来的，而且你不想把list.__len__()记录下来，你应该指定一个选项。:继承成员：列表 以避免列表类的特殊成员。

但我已经尝试过了。

• :继承成员: np. ndarray.
• :继承成员：ndarray
• :继承成员：numpy.ndarray

这些都不妨碍每个类都包含numpy.ndarray的全部文档。 有谁知道有什么办法可以排除numpy文档，但保留我需要的部分？ 谢谢。

Answer 1

正如@Masklinn在评论中解释的那样，需要3.0以上的版本，那么它就可以正确的使用。

:inherited-members: ndarray