如何在reStructuredText文档中交叉引用索引项?
例如,我如何交叉引用SectionB:
.. index::
pair: SectionA; SectionB
SectionB
--------
SectionB description.
我尝试使用:ref:'SectionB'
和:index:'SectionB'
,但它们不起作用。
感谢。
答案 0 :(得分:3)
请参阅:Cross-referencing arbitrary locations
在Sphinx文档中。
我认为您可能缺少的是参考标签,
尝试类似:
.. index::
pair: SectionA; SectionB
.. _section-b-label:
SectionB
--------
SectionB description.
然后在其他地方做:
:ref:`section-b-label`
答案 1 :(得分:0)
在未添加自定义标签的情况下,似乎仍然无法使用此选项。 https://github.com/sphinx-doc/sphinx/issues/1671
处存在一个问题可以使用:term:
链接到词汇表术语,理想情况下可以使用索引链接并将其添加到arbitrary links docs