警告

この記事は古い為 sphinx-users.jp を参照してください。

第13日目 Sphinxドキュメントを編集する その10

昨日は画像やファイルへのリンクについて説明しました。 今日は 索引(インデックス) について説明します。

索引(インデックス)

  • 一般の技術書等には、大抵最後の方に索引が記載されていると思います。Sphinxでもドキュメントに .. index:: ディレクティブを記述する事により索引を作成する事ができます。

singleオプション

記述例:

.. index::
   single: TERRA:THE GUNSLINGER

テラ:ザ・ガンスリンガーとは
============================

single オプションを使うと、このように表示されます。

../../../_images/index_single.png

pairオプション

記述例:

.. index::
   pair: テラ:ザ・ガンスリンガー; シーン制TRPG

テラ:ザ・ガンスリンガーとは
============================

pair オプションを使うと、このように表示されます。

../../../_images/index_pair1.png

pairオプションを使ったインデックスを複数配置する

  • pair オプションを使っても、今一つありがたみが感じられなかったかもしれませんが、複数のインデックスを配置するとなんとなくわかります。

    記述例:

    .. index::
       pair: テラ:ザ・ガンスリンガー; シーン制TRPG
    
    テラ:ザ・ガンスリンガーとは
    ============================
    
    
    .. index::
       pair: トーキョーN◎VA; シーン制TRPG
    
    トーキョーN◎VAとは
    =======================
    

    このように表示されます。

    ../../../_images/index_pair2.png

    シーン制 TRPG という項目に2つのセクションタイトルがまとめて出てきた事がわかりますね。

オプションを複数使う

  • singlepair その他オプションを複数使う事もできます。

    記述例:

    .. index::
       single: TERRA:THE GUNSLINGER
       single: 井上純弌
       pair: テラ:ザ・ガンスリンガー; シーン制TRPG
    
    テラ:ザ・ガンスリンガーとは
    ============================
    
    .. index::
       single: トーキョーノヴァ
       single: F.E.A.R.
       pair: トーキョーN◎VA; シーン制TRPG
    
    トーキョーN◎VAとは
    =======================
    
    .. index::
       single: Night Wizard!
       single: 鈴吹太郎、F.E.A.R.
       pair: ナイトウィザード; シーン制TRPG
    
    ナイトウィザードとは
    =====================
    

    このように表示されます。

    ../../../_images/index_pair3.png

明日は脚注について説明します。

※ このアドベントカレンダーについては このアドベントカレンダーについて を参照して下さい。

Comments

comments powered by Disqus