我可以使用 Sphinx automodule 但在签名中删除模块名称吗？

Question

我有一个mod带有一些子模块的模块submod，并用于.. automodule:: mod.submod为其生成文档。

模块中元素（函数、类等）的签名现在显示限定名称，例如mod.submod.my_function(*args, **kwargs).

我希望 Sphinx 仅显示函数的名称，即签名my_function(*args, **kwargs)。

我有什么办法可以删除签名中的主要模块和子模块吗？

Answer 1

省略函数、方法和变量前面的模块和包名称是通过在以下文件中设置add_module_name配置conf.py来完成的：

add_module_names = False

这并不明显，因为大量的autodoc 配置与sphinx-napoleon 配置一起使您期望在其他地方进行配置。