« Sphinx、csv-tableを使ってテーブル(表)を作る | トップページ | 3/2(水) 第8回 PMstyleスペシャルセミナーのご案内 »

Sphinx、image(画像を挿入するディレクティブ)

しばらくSphinxで文書作成を続けているので、使ったディレクティブ(ピリオド二つで始まる決まった書き方)と、その時の失敗を書いてみます。make結果が思ったような表示にならない原因は、ディレクティブの仕様が書かれている英語サイトをじっくり読まなかったからです。新しいディレクティブを使う時は example のソースコードをコピー&ペーストして make結果を見てみるのが良いかもしれません。

reStructuredText Directives

このページの最初を見ると、ディレクティブのsyntax(構文)が書いてあります。ピリオド二つとスペースで始めて、ディレクティブタイプ(image や contentsなど)を書き、二つのコロン(::)を付けます。後ろには arguments と呼ばれる、そのディレクティブを使う際、必ず書くものと、optionsと呼ばれる追加できる情報を書きます。
例えば、画像を挿入するディレクティブの imageには、画像ファイルのパス(置き場所)が必須です。HTMLで imgタグを使う時に srcが必須なのと同じです。imageのオプションとして、alt(代替テキスト)や width(幅)、height(高さ)、scale(縮小率)などがあります。

Image Directive
日本語の説明部分には scaleの記述はありません。
reStructuredText入門 「画像」

image ディレクティブを使い、元の画像のサイズを変えて表示できることを知った時、私は英語ページの詳細をきちんと読んでおらず、幅と高さ(width、height)に加えて、縮小率(scale)も書いていました。しかし、make結果では想像よりもかなり小さく表示され、どこかがおかしいとよく読んでみました。すると、幅もしくは高さを書けば指定サイズで表示され、scaleも書くと統合される(width または heightに scaleを掛けた割合)ことが分かりました。次のソースコードを makeすると、表示される画像の幅は 100pxになります。

.. image:: images/astah-screenshot.png
   :width: 200px
   :scale: 50%

画像を挿入するディレクティブには他に figure がありますので、次はそちらも使ってみたいと思います。

|

« Sphinx、csv-tableを使ってテーブル(表)を作る | トップページ | 3/2(水) 第8回 PMstyleスペシャルセミナーのご案内 »

Sphinx」カテゴリの記事

コメント

コメントを書く



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


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



トラックバック

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

この記事へのトラックバック一覧です: Sphinx、image(画像を挿入するディレクティブ):

« Sphinx、csv-tableを使ってテーブル(表)を作る | トップページ | 3/2(水) 第8回 PMstyleスペシャルセミナーのご案内 »