我们如何在sphinx文档中嵌入图像？

Question

我是使用sphinx的新手，第一次为python项目做文档。 如何在sphinx文档中嵌入图像？

Answer 1

来自documenation：

  

有两个图像指令：image和figure。

     

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).

Answer 2

使用image指令，例如：

.. image:: example.png

图像的路径是相对于文件的。有关详细信息，请参阅Sphinx documentation。

Answer 3

如果任何人都希望包含内嵌图片，则可以执行以下操作：

The |biohazard| symbol must be used on containers used to dispose of medical waste.

.. |biohazard| image:: biohazard.png

（来自https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#substitution-definitions）