让我们考虑以下函数:
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中用于引用模块的标签是什么?
:module:
和:mod:
是等价的……谢谢。 - FunkySayu