Question

我正在使用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文档中的特定位置？

Answer 1

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

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

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

此处有更多详情：

Sphinx中方法的内部超链接

1 个答案: