索引したい（index）

1```{eval-rst}
2.. index::
3    タイプ: 索引1; 索引2
4```

indexを使って、ページを索引（インデックス）に登録できます。 索引の登録方法にはさまざまな種類（single / pair/ triple / see / seealso）があるので、適切なものを選択してください。 また;で区切って複数の索引を設定できます。

HTMLをビルドした場合、ドキュメント全体から集めた索引はgetindexに書き出され、索引ページで確認できます。 PDFをビルドした場合、文書の最後に「索引」の章が追加され、該当ページへの相互参照が表示されます。

ヒント

ロールを使うと単語単位で索引に登録できます。 このドキュメントでは、各ページの先頭でディレクティブを使ってページ単位で索引に登録することにしています。 具体的な使い方は、このページの.mdソースも確認してください。

目的別検索したい（single）

1```{eval-rst}
2.. index::
3    single: 目的別の見出し; キーワード
4```

singleオプションに2つの索引を登録すると、目的別検索（逆引き検索）のように索引を使うことができます。

相互索引したい（pair）

1```{eval-rst}
2.. index::
3    pair: 索引1; 索引2
4```

pairオプションを使うと、1つのページを複数の索引に登録できます。

注釈

このページはpair: Sphinx; indexを設定しています。 索引を確認するとSphinx -> indexとindex -> Sphinxの両方から検索できることがわかります。

（あたりまえですが）索引は、1ページだけに設定してもおもしろくありません。 複数ページに設定することで、ドキュメントの検索性が高まります。

その他の種類の索引したい

1```{eval-rst}
2.. index:
3    triple: 索引1; 索引2; 索引3
4    see: 見出し; キーワード
5    seealso: 見出し; キーワード
6```

tripleは3つの索引を循環して、索引に表示できます。 seeとseealsoは見出しに対して、索引を登録して使うとよさそうです。 日本語の場合、それぞれ「〜を参照」「〜も参照」と表示されますが、ページへのリンクは作成されません。