禁用由 numpydoc 创建的自动自动摘要

Question

在使用autodoc 时是否可以禁用完整的autosummary？

我有一个派生自Python standard library class 的类，它有许多公共方法。我的自定义类应该用作包装器，直接提供使用其协议与我的设备通信的方法。 因此，我只想在 autosummary 表中包含一些选定的继承方法。

.. autoclass:: my_module.MyClass
   :members:
   :show-inheritance:

   .. autosummary::
      my_method
      another_method

..autosummary:: 块完全符合我的要求，但..autoclass:: 会自动创建一个完整的方法表。有没有办法禁用此功能？

---

编辑（澄清）

直接使用 autosummary 指令，我能够生成仅包含 my_method 和 another_method 的方法表：

.. autosummary::
   my_method
   another_method

但是，当使用 autoclass 或 automodule 没有以下 autosummary 指令时，我仍然得到一个方法表看起来与上面的 autosummary 块创建的完全一样，只是描述了所有方法：

.. autoclass:: my_module.MyClass
   :members:
   :show-inheritance

---

编辑 2

numpydoc 正在生成“完整”自动汇总表。

Answer 1

“问题”不在 autodoc 或 autosummary 中。
虽然问题中没有提到我正在使用numpydoc，它正在生成额外的 autosummary 表。

如numpydoc's documentation 中所述，可以通过将numpydoc_show_inherited_class_members = False 添加到狮身人面像conf.py 来禁用此功能。

Answer 2

您可以删除:members: 标记，或在:members: 之后包含一个逗号分隔列表，仅列出您希望包含在文档中的方法。