python - Sphinx meth 角色不创建链接

Question

在 python 模块中，在模块的文档字符串中我有以下内容:

:meth:`my_method`

我在当前模块中有以下类:

class GameP:

    ...

    def my_method(self):
        return f"{self._name} {self.selected}"

Sphinx 不会为此创建链接，而在 Sphinx 文档中我们有:

Normally, names in these roles are searched first without any further qualification, then with the current module name prepended, then with the current module and class name (if any) prepended. If you prefix the name with a dot, this order is reversed. For example, in the documentation of Python’s codecs127 module, :py:func:open always refers to the built-in function, while :py:func:.open refers to codecs.open().

为什么粗体部分不适合我？ :meth: 角色不会为我建立链接。

Answer 1

恕我直言，该文档不是非常清晰，但如果您使用 :meth:`.my_method` (带点)，它就可以工作。点使 Sphinx 在任何地方寻找 my_method 的匹配项。

如果交叉引用在 GameP 类的文档字符串中，则不需要点。但在这种情况下，交叉引用位于模块文档字符串中，并且在模块级别上没有“当前类名”。