Sphinx：交叉引用索引项

Question

如何在 reStructuredText 文档中交叉引用索引项？

例如，如何交叉引用SectionB：

.. index::
    pair: SectionA; SectionB

SectionB
--------

SectionB description.

我尝试在参考文献中使用索引标签，例如：

:ref:`SectionB`

但这不起作用。

Answer 1

参见：交叉引用任意位置

在 Sphinx 文档中。

我认为您可能缺少的是参考标签，

尝试类似：

.. index::
pair: SectionA; SectionB

.. _section-b-label:

SectionB
--------

SectionB description.

然后在其他地方做：

:ref:`section-b-label`

Answer 2

Sphinx（现在，自 2016 年 v1.4 起）有一个 autosectionlabel 扩展，它完全可以满足您的需求：

此扩展允许您引用其标题的部分。这影响到 参考角色（ref）。

例如：

A Plain Title
-------------

This is the text of the section.

It refers to the section title, see :ref:`A Plain Title`. 

在内部， 该扩展为每个部分生成标签。如果是同一段 名称在整个文档中使用，任何一个都用于目标 默认。 autosectionlabel_prefix_document 配置变量 可用于制作多次出现的标题，但在 不同的文件是独一无二的。

Answer 3

如果不添加自定义标签，这个选项似乎仍然不可能。 有一个问题在 https://github.com/sphinx-doc/sphinx/issues/1671

可以使用

:term:

链接到术语表术语，理想情况下索引链接是可能的，并添加到 任意链接文档