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

【问题标题】：Interal hyperlink to automethod in SphinxSphinx 中自动方法的内部超链接
【发布时间】：2015-02-21 19:20:12
【问题描述】：

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

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

.. automodule:: module_name

    .. autoclass:: class_name

        .. automethod:: method_a

        .. automethod:: method_b

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

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

如何在我的 API 文档中提供指向特定位置的链接？

【问题讨论】：

标签： python-sphinx

【解决方案1】：

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

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

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

更多细节在这里：

【讨论】：