Sphinx meth角色不创建链接



在python模块中,在模块的docstring中我有以下内容:

:meth:`my_method`

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

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

Sphinx不创建链接,而在Sphinx文档中我们有:

通常,首先搜索这些角色中的名称,不需要任何进一步的限定,然后加上当前模块名,然后加上当前模块和类名(如有)前置。如果在名称前加上点,则顺序颠倒。例如,在Python的codecs127模块的文档中,:py:func:open总是指向内置函数,而:py:func:.open指向codecs.open()。

为什么粗体部分不适合我?:meth:role不为我创建链接

文档不是很清楚,但如果您使用:meth:`.my_method`(带点),它可以工作。这个点使Sphinx在任何地方寻找与my_method匹配的。

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

最新更新