第13日目 Sphinxドキュメントを編集する その１０
昨日は画像やファイルへのリンクについて説明しました。 今日は 索引(インデックス) について説明します。
索引(インデックス)
- 一般の技術書等には、大抵最後の方に索引が記載されていると思います。Sphinxでもドキュメントに .. index:: ディレクティブを記述する事により索引を作成する事ができます。
singleオプション
記述例:
.. index:: single: TERRA:THE GUNSLINGER テラ:ザ・ガンスリンガーとは ============================single オプションを使うと、このように表示されます。
pairオプション
記述例:
.. index:: pair: テラ:ザ・ガンスリンガー; シーン制TRPG テラ:ザ・ガンスリンガーとは ============================pair オプションを使うと、このように表示されます。
pairオプションを使ったインデックスを複数配置する
pair オプションを使っても、今一つありがたみが感じられなかったかもしれませんが、複数のインデックスを配置するとなんとなくわかります。
記述例:
.. index:: pair: テラ:ザ・ガンスリンガー; シーン制TRPG テラ:ザ・ガンスリンガーとは ============================ .. index:: pair: トーキョーＮ◎ＶＡ; シーン制TRPG トーキョーＮ◎ＶＡとは =======================
このように表示されます。
シーン制 TRPG という項目に2つのセクションタイトルがまとめて出てきた事がわかりますね。
オプションを複数使う
single や pair その他オプションを複数使う事もできます。
記述例:
.. index:: single: TERRA:THE GUNSLINGER single: 井上純弌 pair: テラ:ザ・ガンスリンガー; シーン制TRPG テラ:ザ・ガンスリンガーとは ============================ .. index:: single: トーキョーノヴァ single: F.E.A.R. pair: トーキョーＮ◎ＶＡ; シーン制TRPG トーキョーＮ◎ＶＡとは ======================= .. index:: single: Night Wizard! single: 鈴吹太郎、F.E.A.R. pair: ナイトウィザード; シーン制TRPG ナイトウィザードとは =====================
このように表示されます。
明日は脚注について説明します。
※ このアドベントカレンダーについては このアドベントカレンダーについて を参照して下さい。
第12日目 Sphinxドキュメントを編集する その９
昨日は他のドキュメント( rstファイル )やセクションへのリンクについて説明しました。 今日はファイルのダウンロードリンクや画像へのリンクについて説明します。
ファイルをダウンロードさせるリンク
プロジェクト 内に存在するファイルへのダウンロード用リンクを張る事ができます。
記述例:
:download:`ダウンロードできます <../../../files/build_and_browsing.zip>`
このように表示されます。
画像を表示する ～imageディレクティブ～
画像を表示させたい場合は .. image:: というディレクティブを使います。
まずはPythonの pillowパッケージ をインストールしましょう。
easy_install -U pillow
pillowパッケージ がインストール出来たら imageディレクティブのオプションが使えるようになります。
記述例:
.. image:: ../../../img/background.png :scale: 50 :align: left :target: http://sphinx-users.jp/
htmlこのように表示されます。
- scale は縮小、拡大をする時のオプションです。100が1/1スケールです。
- target リンク先を指定する事ができます。
明日は索引(インデックス)について説明します。
※ このアドベントカレンダーについては このアドベントカレンダーについて を参照して下さい。