我想添加一个指向一个模块(比如module_2.py(中一个类的方法的链接，在另一个模块(比如module_1.py(的另一个方法中。我希望链接在狮身人面像中工作。
假设：
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")
若要真正获取超链接，方法引用需要包含完整路径。创建任何链接的最简单方法是使用:obj:交叉引用：
"""See docstring of :obj:`path.to.module_2.XYZ.bar`."""
请参阅
path.to.module_2.XYZ.bar的文档字符串。
您可以使用平铺~将锚文本缩短为路径的最后一个元素：
"""See docstring of :obj:`~path.to.module_2.XYZ.bar`."""
请参阅
bar的文档字符串。
或者指定自定义文本，如下所示：
"""See docstring of :obj:`XYZ.bar <path.to.module_2.XYZ.bar>`."""
请参阅
XYZ.bar的文档字符串。
这也许是最方便读者的解决方案。
为了完整起见，请注意:obj:是一般的非类型引用，但 Sphinx 提供了其他几种类别的交叉引用和一些特定的行为。
你可以这样写：
class ABC:
def foo(self):
"""
See docstring of :py:meth:`bar() <XYZ.bar>` in :py:mod:`module_2`.
"""
print("foo")
显示的标记使用角色链接到记录的元素。如果 Python 是文档的默认域，则可以省略:py。角色meth链接到方法名称。可以使用虚线名称。同样，mod链接到模块名称。角色的内容写在 wetween``.内容(逻辑链接名称可以具有不同的视觉内容。因此，逻辑链接名称以<>编写。示例：:role:`text <logical name>`.
更多信息：http://www.sphinx-doc.org/en/stable/domains.html#role-py:meth