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

Question

如何在 Sphinx 文档中嵌入图像？

Answer 1

来自文档：

有两个图像指令：
image
和
figure
。
image
是一张简单的图片。

A
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 文档了解更多信息。

Answer 3

如果有人希望包含内联图像，可以使用以下方法：

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

.. |biohazard| image:: biohazard.png

Answer 4

确保上面的线之间有一条线，上面写着.. image::

我的图像没有显示，但我只需将其与其上方的文本行分开。

Answer 5

由于必须使用相对路径，因此我创建了一个

images

目录，在这种情况下，我需要使用以下内容作为图像路径：

.. image:: ..\\images\\image.png