web-dev-qa-db-ja.com

Sphinxドキュメントに画像を埋め込むにはどうすればよいですか？

pythonプロジェクトで初めてドキュメントを作成する。スフィンクスのドキュメントに画像を埋め込む方法は？

python-sphinx
34
Ciasto piekarz

imageディレクティブを使用します。次に例を示します。

.. image:: example.png

画像へのパスはファイルに相対的です。詳細については、 Sphinx documentation を参照してください。

20
devin_s

documenation から：

imageとfigureの2つの画像ディレクティブがあります。

imageは単純な図です。

figureは、画像データ（画像オプションを含む）、オプションのキャプション（単一の段落）、およびオプションの凡例（任意のボディ要素）で構成されます。ページベースの出力メディアの場合、これがページレイアウトに役立つ場合、図は別の位置に浮かぶことがあります。

imageの使用例：

.. image:: picture.jpg
   :width: 200px
   :height: 100px
   :scale: 50 %
   :alt: alternate text
   :align: right

figureの使用例：

.. figure:: picture.png
   :scale: 50 %
   :alt: map to buried treasure

   This is the caption of the figure (a simple paragraph).
43
Jacek Krawczyk