Sphinx：链接到Python文档字符串中另一个模块中类的方法

Question

我想在另一个模块（例如module_2.py）的另一个方法中添加指向一个模块（例如module_1.py）中类的方法的链接。我希望链接在Sphinx中可用。

假设：

module_1.py

class ABC:
   def foo(self):
      """
      See docstring of module_2.py bar():<link to bar() in module_2.py>
      """
      print("foo")

module_2.py

class XYZ:
    def bar(self):
    """
    This function prints hello.
    """
    print("hello")

Answer 1

您可以写：

class ABC:
  def foo(self):
    """
    See docstring of :py:meth:`bar() <XYZ.bar>` in :py:mod:`module_2`.
    """
    print("foo")

显示的标记使用role链接到记录的元素。如果Python是文档的默认域，则可以省略:py。角色meth链接到方法名称。可以使用点名。同样，mod链接到模块名称。角色的内容写在``之间。内容（逻辑链接名称可以具有不同的视觉内容。因此，逻辑链接名称写在<>中。例如：:role:`text <logical name>`。

更多信息：http://www.sphinx-doc.org/en/stable/domains.html#role-py:meth

Answer 2

要真正获得超链接，您的方法引用必须包含完整的路径。创建任何链接的最简单方法是使用:obj:交叉引用：

:obj:

请参见"""See docstring of :obj:`path.to.module_2.XYZ.bar`.""" 的文档字符串。

您可以使用path.to.module_2.XYZ.bar将锚文本缩短到路径的最后一个元素：

tild ~

请参见~的文档字符串。

或这样指定"""See docstring of :obj:`~path.to.module_2.XYZ.bar`.""" ：

bar

请参见custom text的文档字符串。

这可能是最易于阅读的解决方案。

为了完整起见，请注意，"""See docstring of :obj:`XYZ.bar <path.to.module_2.XYZ.bar>`.""" 是一般的无类型引用，但是Sphinx为XYZ.bar提供了一些特定的行为。