如何使用类名停止Sphinx automethod前缀方法名称

Question

当我使用Sphinx automethod来记录这样的特定方法时：

.. automethod:: my_module.MyClass.my_method

生成的文档将类名附加到方法名称，如下所示：

MyClass.my_method(kwarg1=None, kwarg2=None)

    This is the docstring for my_method...

有没有办法告诉automethod不要在方法名称前加上类名，这样生成的文档看起来像这样：

my_method(kwarg1=None, kwarg2=None)

    This is the docstring for my_method...

?

Answer 1

此外

add_module_names = False

使用

.. autofunction:: my_module.MyClass.my_method

而不是automodule，生成的doc中省略了类名。

Answer 2

在conf.py文件中添加此行

add_module_names = False