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

Question

我有一个模块 mod 和一些子模块 submod 并使用 .. automodule::mod.submod 为它生成文档。

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

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

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

Answer 1

通过设置 add_module_name configuration 来省略函数、方法和变量之前的模块和包名称。在你的 conf.py 中:

add_module_names = False

这并不明显，因为有很多 autodoc configurations连同 sphinx-napoleon configurations让你期待其他地方的配置。