Python sphinx 禁用由numpydoc创建的自动摘要
使用时是否可以禁用完整的 我有一个派生自的类,它有许多公共方法。我的自定义类应该作为包装器工作,直接提供使用其协议与设备通信的方法。 因此,我只想在自动汇总表中包含一些选定的继承方法Python sphinx 禁用由numpydoc创建的自动摘要,python-sphinx,autodoc,numpydoc,Python Sphinx,Autodoc,Numpydoc,使用时是否可以禁用完整的 我有一个派生自的类,它有许多公共方法。我的自定义类应该作为包装器工作,直接提供使用其协议与设备通信的方法。 因此,我只想在自动汇总表中包含一些选定的继承方法 .autosummary::块完全符合我的要求,但是.autoclass::会自动创建一个完整的方法表。有没有办法禁用此功能 编辑(澄清) 直接使用autosummary指令,我能够生成一个只包含my\u method和另一个\u method的方法表: .. autosummary:: my_method
.autosummary::
块完全符合我的要求,但是.autoclass::
会自动创建一个完整的方法表。有没有办法禁用此功能
编辑(澄清) 直接使用autosummary指令,我能够生成一个只包含
my\u method
和另一个\u method
的方法表:
.. autosummary::
my_method
another_method
但是,在使用autoclass或automodule时,如果没有以下自动汇总指令,我仍然会得到一个与上面自动汇总块创建的方法表完全相同的方法表,仅在描述了所有方法的情况下:
.. autoclass:: my_module.MyClass
:members:
:show-inheritance
编辑2
“完整”自动汇总表是由生成的。您可以删除
:members:
标记,或者在:members:
后面包含一个逗号分隔的列表,其中仅包含要包含在文档中的方法 问题不在autodoc或autosummary中。虽然在我使用的问题中没有提到,但它生成了额外的自动汇总表
如中所述,可以通过将
numpydoc\u show\u inheritated\u class\u members=False
添加到sphinxconf.py
来禁用此功能。这只影响详细描述的方法,而不影响由autosummaryautoclass
生成的表生成我要配置的自己的autosummary
块(或禁用)以获取显式。自动摘要::
块的行为。
.. autoclass:: my_module.MyClass
:members:
:show-inheritance