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

Question

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

.. automethod:: my_module.MyClass.my_method

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

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

    This is the docstring for my_method...

有什么方法可以告诉 automethod 不要 在方法名称前加上 class 名称前缀，这样生成的文档如下所示：

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 并且在生成的文档中省略了 class 名称。