sphinxで索引ページを作成する#

sphinxでは、索引ページを作成する機能があります。

索引ページとは#

本の巻末で見つけるアルファベット順、50音順に並んだ用語集のようなページのこと。

仕組み#

  • sphinxがhtmlビルド時に genindex.html を勝手に作ってくれます。

  • :ref:`genindex` とすることで索引へのリンクを張ることができます。

  • 各rstページの「indexディレクティブ」「glossaryディレクティブ」から単語を集めて索引化します。

Tip

toctree で索引へのリンクさせたい場合は、genindex.rstを作成します [1]

indexディレクティブ#

indexディレクティブ:

.. index :: <entries>

  • ページ側に表示はされず、索引に収集されるための印のように使う。

  • 複数の単語の索引に紐づけることができる。⇒ [2]

Tip

  • 全て最初の文字で分類され、ひらがな、カタカナ、漢字は別文字扱い。日本語としては使いにくい

  • Sphinx拡張の記事 [3] で日本語で柔軟な索引が作れるとの情報。試したが、当サイトが環境事情でPython3.7のためコンパイルが通らず、評価できずにいる。

glossaryディレクティブ#

glossaryディレクティブ:

../ glossary ::

  term 1 : た
  term 2 : た
    Definition of both terms.