« Agile Japan 2011、プログラム公開と参加登録開始 | トップページ | 2/10(木)、ビジネスに活かすソーシャルメディア入門に参加 »

Sphinx、セクションのヘッダを比べてみる

Sphinxでは文字列にアンダーラインを付けて、見出しや小題を作ります。見出しにしたい文字列の次行に、アスタリスクやイコール、ハイフンで下線を書いて makeすると、太字や他の文字列と異なる色で表示されます。記号によってどのような見出しになるのか試してみました。

ソースコード

===============
Section Title
===============

表示確認、上下二重線

---------------
Section Title
---------------

表示確認、上下破線


Section Title
=============

表示確認、下のみ二重線

Section Title
-------------

表示確認、下のみ破線

Section Title
`````````````

表示確認、下のみシングルクォート

Section Title
'''''''''''''

表示確認、下のみカンマ

Section Title
...............

表示確認、下のみピリオド

Section Title
~~~~~~~~~~~~~

表示確認、下のみチルダ(波の形)

Section Title
*************

表示確認、下のみアスタリスク


Section Title
+++++++++++++

表示確認、下のみプラス


Section Title
^^^^^^^^^^^^^

表示確認、下のみサーカムフレックス(山の形)

上記のソースコードを makeした結果が次の画像です。

,p20110210

201102102

Sphinxdoc と haiku の二種類のテーマで見てみましたが、どちらも途中から表示サイズや色、太さが変わらなくなりました。(7番目に使った記号から変化がなくなる) 日本語のreStructuredText入門 「セクション」を読むと、次の記述がありましたので、これは出力形式であるHTMLの制限だと思われます。

- 引用 -
「ただし、ほとんどの対象となる出力フォーマット(HTML, LaTeX)は、ネストできる深さには限界が設定されている、ということは忘れないでください。」

上下に記号を使ったものと、下のみに使ったものは異なるレベルの見出しと認識されますが、上下の記号の種類と長さ(桁数)が揃っていなければなりません。英語の解説を読むと、特に見出しに適した記号があると書かれていました。

= - ` : . ' " ~ ^ _ * + #

記号を使って見出しを作ると、自動でこの見出しへのハイパーリンクが生成され、"reference name"と呼ばれるハイパーリンクのターゲットはセクションタイトルと同じになります。

|

« Agile Japan 2011、プログラム公開と参加登録開始 | トップページ | 2/10(木)、ビジネスに活かすソーシャルメディア入門に参加 »

Sphinx」カテゴリの記事

コメント

コメントを書く



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


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



トラックバック

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

この記事へのトラックバック一覧です: Sphinx、セクションのヘッダを比べてみる:

« Agile Japan 2011、プログラム公開と参加登録開始 | トップページ | 2/10(木)、ビジネスに活かすソーシャルメディア入門に参加 »