インデックス

索引を作るためのインデックスです。索引のページに項目の一覧が作られて、そこからこのインデックスにリンクが張られます。

このページに表示される出力例は、全て索引ページ（genindex.html）の表示例です。（入力例の「数値の覚え方」のページには、indexディレクティブは表示されません。）

基本的なパターン

リンクしたい部分の前にindexを書きます。indexの後ろに書いた文言が検索ページに表示されます。タイトルと異なる文字でもかまいません。

入力例

.. index:: 数値の覚え方

数値の覚え方
==================

２の平方根
   ひとよひとよにひとみごろ

３の平方根
   ひとなみにおごれや

出力例

../_images/rst_syntax_index_01.png

複数のインデックスを付ける

indexの後にカンマ区切りで文言を書くと、複数のインデックスを付けられます。

入力例

.. index:: ２の平方根, ３の平方根

数値の覚え方
==================

２の平方根
   ひとよひとよにひとみごろ

３の平方根
   ひとなみにおごれや

出力例

../_images/rst_syntax_index_02.png

サブエントリー

インデックスの文言をセミコロン（；）で区切ると、サブエントリーになります。

入力例

.. index:: 数値の覚え方; 平方根

数値の覚え方
==================

２の平方根
   ひとよひとよにひとみごろ

３の平方根
   ひとなみにおごれや

出力例

../_images/rst_syntax_index_03.png

ペア

pairオプションを使うと、２つのインデックスが作られます。

入力例

.. index::
   pair: ２の平方根; ３の平方根

数値の覚え方
==================

２の平方根
   ひとよひとよにひとみごろ

３の平方根
   ひとなみにおごれや

出力例

../_images/rst_syntax_index_04.png

tripleもあります。

入力例

.. index::
   triple: 覚え方; 数値; 平方根

数値の覚え方
==================

２の平方根
   ひとよひとよにひとみごろ

３の平方根
   ひとなみにおごれや

出力例

../_images/rst_syntax_index_05.png