Sphinx 中自动方法的内部超链接

Question

我正在使用 Sphinx 来记录一个 python 项目。该文档包括 API 参考和用户指南。我想将用户指南中的 links 包含到 API 参考的相关部分，但似乎无法弄清楚。

我的 API 引用使用了 autodoc 扩展；但是，我单独列出了我的方法，例如：

.. automodule:: module_name

    .. autoclass:: class_name

        .. automethod:: method_a

        .. automethod:: method_b

在另一个第一个文件中，我有我的用户指南。我可以使用 ref link 到另一个第一个文件中的任意位置；但是，标签似乎必须位于节标题之前。因此，例如以下内容不起作用。

userguide.rst

see :ref:`my-reference-label` for more details on method_b

api.rst

.. automodule:: module_name

    .. autoclass:: class_name

        .. automethod:: method_a

        .. _my-reference-label:

        .. automethod:: method_b

如何 link 到我的 API 文档中的特定位置？

Answer 1

您不需要定义标签。可以使用 :py:meth: 角色创建指向 method_b 的超链接：

:py:meth:`module_name.class_name.method_b`

可以通过多种方式自定义和简化此标记（例如，当 domain 为 Python 时，不需要 :py 前缀）。

此处有更多详细信息：

Sphinx 中自动方法的内部超链接

Interal hyperlink to automethod in Sphinx

python-sphinx