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

disable automatic autosummary created by numpydoc

是否可以禁用完整的autosummary when using autodoc

我有一个从 Python standard library class 派生的 class,它有许多 public 方法。我的自定义 class 应该作为包装器工作,直接提供使用其协议与我的设备通信的方法。 因此,我只想在 autosummary table.

中包含一些选定的继承方法
.. autoclass:: my_module.MyClass
   :members:
   :show-inheritance:

   .. autosummary::
      my_method
      another_method

..autosummary:: 块完全符合我的要求,但是 ..autoclass:: 自动创建了一个完整的方法 table。有没有办法禁用此功能?


编辑(澄清)

直接使用 autosummary 指令,我能够生成仅包含 my_methodanother_method 的方法 table:

.. autosummary::
   my_method
   another_method

但是,当使用 autoclassautomodule 而没有跟随 autosummary 指令,我仍然得到一个方法 table 看起来与上面 autosummary 块创建的方法完全一样,只是描述了所有方法:

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

编辑 2

"complete" 自动摘要 table 正在由 numpydoc 生成。

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

"problem" 不在 autodocautosummary.
中 虽然在问题中没有提到我正在使用 numpydoc,它生成了额外的 autosummary table.

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