Python 模块参考与 Sphinx 文档

Question

让我们考虑以下功能：

def format_send_event(self, message_identifier, payload=""):
    """
    Format a SendEvent.

    :param message_identifier: Message identifier (defined in the :py:module:`MyModule.constants` file).
    :type message_identifier: int
    :param payload: Payload of the message.
    :type payload: str
    """
    # Do something

当我用 sphinx-build 编译它时，出现以下错误：

...MyModule/handlers.py:docstring of MyModule.handlers.MyClass.format_send_event:3: ERROR: Unknown interpreted text role "py:module".

看起来 sphinx-builder 无法理解标签:py:module: 。

在 Sphinx 中用于引用模块的标签是什么？

Answer 1

根据文档，您应该使用:py:mod:进行交叉引用。

通常，较短版本的标签似乎用于交叉引用，而较长的名称用于文档。