python-sphinx - Sphinx: 相互参照インデックス付きアイテム

Question

reStructuredText ドキュメント内のインデックス付きアイテムを相互参照するにはどうすればよいですか?

たとえば、セクション B を相互参照するにはどうすればよいですか。

.. index::
    pair: SectionA; SectionB

SectionB
--------

SectionB description.

次のような参照でインデックス ラベルを使用してみました。

:ref:`SectionB`

しかし、これは機能しません。

Answer 1

参照:任意の場所の相互参照

スフィンクスのドキュメントで。

あなたが見逃しているかもしれないのは参照ラベルだと思います.

次のようなものを試してください：

.. index::
pair: SectionA; SectionB

.. _section-b-label:

SectionB
--------

SectionB description.

そして、他の場所で次のことを行います。

:ref:`section-b-label`