1

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

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

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

   .. autosummary::
      my_method
      another_method

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

编辑（澄清）

直接使用autosummary指令，我可以生成一个只包含my_methodand的方法表another_method：

.. autosummary::
   my_method
   another_method

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

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

编辑 2

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

4

2 回答 2

3

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

如numpydoc 的文档中所述，可以通过添加numpydoc_show_inherited_class_members = False到 sphinx来禁用此功能conf.py。

于 2016-03-23T18:05:19.100 回答
0

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

于 2016-03-23T14:24:07.823 回答