如何使用类名停止Sphinx自动方法前缀方法名

Question

当我使用Sphinx自动方法来记录特定方法时，如下所示：

.. automethod:: my_module.MyClass.my_method

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

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

    This is the docstring for my_method...

有什么方法可以告诉自动方法不要在方法名称前加上类名称，以使生成的文档如下所示：

my_method(kwarg1=None, kwarg2=None)

    This is the docstring for my_method...

？

Answer 1

在您的conf.py文件中添加这一行

add_module_names = False

Answer 2

此外

add_module_names = False

用

.. autofunction:: my_module.MyClass.my_method

而不是，automodule并且在生成的文档中省略了类名。