禁用numpydoc创建的自动摘要

Question

是否可以在使用自动摘要时禁用完整的自动医生？

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

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

   .. autosummary::
      my_method
      another_method

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

编辑(澄清)

直接使用自动摘要指令，我可以生成一个只包含my_method和another_method的方法表

.. autosummary::
   my_method
   another_method

然而，当使用autoclass或automodule 而没有遵循自动摘要指令时，我仍然会得到一个与上面的自动摘要块创建的方法表完全一样的方法表，只有描述了所有方法：

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

编辑2

“完整”自动汇总表是由农比多生成的。

Answer 1

“问题”不在autodoc或自动摘要中。

虽然在问题中没有提到，但我使用的是农比多，它生成了附加的自动汇总表。

正如numpydoc的文件中所描述的那样，可以通过将numpydoc_show_inherited_class_members = False添加到狮身人面像conf.py中来禁用此功能。

Answer 2

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