Guidedog / ドキュメント 0.2.0

画像、動画、音声、ダウンロード¶

リソースは説明する文書の近くに置きます。相対パス、または / で始まるソースルートからのパスで指定します。文書が使うリソースをコピーします。動画はウェブで再生でき、PDF では録画の情報を示します。

画像¶

.. image:: diagrams/pipeline.png
   :alt: The build pipeline
   :width: 480px

.. figure:: /screenshots/search.png

   Searching the site.

ページは画像を _images にコピーし、本は埋め込みます。PNG、JPEG、GIF、SVG、WebP は両方で使えます。画像がない場合は警告し、ページは代替テキストを残し、本は画像を省きます。

動画と音声¶

image や figure が動画（.mp4、.webm、.ogv、.mov、.m4v）または音声（.mp3、.ogg、.oga、.m4a、.opus、.wav、.flac、.aac）を指す場合は再生します。動画に対する Docutils と同じ動作です。

.. figure:: media/tour.mp4
   :alt: A tour of the site
   :width: 640

   The two-minute tour.

.. image:: media/pronunciation.mp3

ページではブラウザのプレーヤーと、再生できない場合のファイルリンクを表示します。本は再生できないため、その位置の枠内に録音・録画を示します。テキスト出力は [video: ...] または [audio: ...] を書きます。

ダウンロード¶

download ロールは任意のファイルにリンクし、_downloads にコピーします。

Get :download:`the example project <examples/project.zip>`.

テーマのファイル¶

_static にテーマのスタイルシート、スクリプト、フォント、ロゴを置き、そのままサイトの _static にコピーします。html_static_path でディレクトリを指定し、html_css_files、html_js_files、html_logo、html_favicon でファイルを指定します。本文のメディアは文書と同じ場所に置けば、一緒に移動してもリンクが保たれます。