我可以使用sphinx自动模块但是在签名中删除模块名称吗？

Question

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

模块中元素（函数，类等）的签名现在看起来像mod.submod.my_function(*args, **kwargs)。

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

我有没有办法删除签名中的主要模块和子模块？

Answer 1

是的，请在docs/mod/submod.rst中尝试：

.. automodule:: mod.submod

    .. autofunction:: my_function

请参阅Pyramid文档中的示例HTML build和reST source。

额外奖励：请参阅Cross-referencing syntax的Sphinx文档：

如果使用~为内容添加前缀，则链接文本将只是目标的最后一个组件。例如，：py：meth：~Queue.Queue.get将引用Queue.Queue.get但仅显示get作为链接文本。