禁用numpydoc创建的自动autosummary

Question

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

我有一个派生自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

＆＃34;完成＆＃34; autosummary表由numpydoc生成。

Answer 1

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

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

Answer 2

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