警告

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

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

昨日は他のドキュメント( rstファイル )やセクションへのリンクについて説明しました。 今日はファイルのダウンロードリンクや画像へのリンクについて説明します。

ファイルをダウンロードさせるリンク

  • プロジェクト 内に存在するファイルへのダウンロード用リンクを張る事ができます。

    記述例:

    :download:`ダウンロードできます <./files/build_and_browsing.zip>`

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

    ダウンロードできます

画像を表示する ～imageディレクティブ～

  • 画像を表示させたい場合は .. image:: というディレクティブを使います。

    まずはPythonの pillowパッケージ をインストールしましょう。

    easy_install -U pillow

    pillowパッケージ がインストール出来たら imageディレクティブのオプションが使えるようになります。

    記述例:

    .. image:: ./images/background.png
   :scale: 50
   :align: left
   :target: http://sphinx-users.jp/

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

    ../../../_images/background.png

    • scale は縮小、拡大をする時のオプションです。100が1/1スケールです。

    • target リンク先を指定する事ができます。

明日は索引(インデックス)について説明します。

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

第11日目 Sphinxドキュメントを編集する その８   第13日目 Sphinxドキュメントを編集する その１０