« 誰にとっての分かりやすさか | トップページ | ブラジル UENPでの学部10周年記念イベント »

Sphinxのディレクティブで、special admonitionを使ってみる

Sphinx 1.1のドキュメントサイトを見ていたら、reStructuredText入門のページに淡い背景色がある"See also"という囲み文章がありました。これはどうやって書いているのだろうと、ソースを表示してみたら表示とディレクティブが同じでした。

.. seealso::
文章

真似してローカルのSphinxドキュメントに seealsoを追記してみたら、こんな表示になりました。
20110614seealso

私が使っているHTMLテーマ「haiku」では、背景色が淡いグリーンになりました。そして、seealsoは日本語で「参考」と表示されています。このディレクティブは、忠告としてまとめられている admonitionの一つで他にもいくつかあります。どんな表示になるか興味があったので試してみました。

まずは、attention。枠がうっすらと見えるだけで色は付いていません。
20110614attention

cautionは「ご用心」、dangerは「危険」、errorは「エラー」、importantは「重要」で、表示はattentionと同様でした。tipも表示は同じですが、「ちなみに」と訳されていました。「tip」と「ちなみに」の意味合いは、少し違うような気もします。

続いて、noteを使ってみるとアイコン?が表示されました。
20110614note

warningは、背景が淡い黄色になって画像も付いています。
20110614warning

ほとんどのテーマが note、warningにだけスタイルを適用すると書かれている中、haikuテーマは seealsoにも適用されることが分かりました。dangerやcautionの見た目が予想外におとなしい点は少し残念ですが、noteやwarningは目立たせたいところに使うと良いかもしれません。

|

« 誰にとっての分かりやすさか | トップページ | ブラジル UENPでの学部10周年記念イベント »

Sphinx」カテゴリの記事

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.f.cocolog-nifty.com/t/trackback/98967/40395492

この記事へのトラックバック一覧です: Sphinxのディレクティブで、special admonitionを使ってみる:

« 誰にとっての分かりやすさか | トップページ | ブラジル UENPでの学部10周年記念イベント »