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

Question

我在使用Sphinx上是比较新的，第一次为Python项目做文档。 如何在Sphinx文档中嵌入图片？

- Ciasto piekarz

Answer 1

根据文档:

有两种图像指令：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).

- Jacek Krawczyk

Answer 2

使用image指令，例如：

.. image:: example.png

图片路径是相对于文件的。请参阅Sphinx文档获取更多信息。

- devin_s

---

我建议尝试使用“.. figure::”指令，它具有一些不错的功能。 - wswld

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）

- Ken

---

正是我正在搜索的，谢谢！一旦您在某个地方定义了图像，链接（这里是 |生物危害|）就可以在同一文档页面内轻松重复使用。 - jeannej

Answer 4

确保在上面这行话之间有一行空白，该行话是 .. image::

我的图片没有显示出来，但我只需要把它与上面的文字分开就好了。

- loftusmi3

Answer 5

由于您必须使用相对路径，因此我创建了一个名为images的目录，在这种情况下，我需要使用以下图像路径： .. image:: ..\\images\\image.png

- Trevor Arnold

---

目前你的回答不够清晰，请编辑并添加更多细节，以帮助其他人理解它如何回答问题。你可以在帮助中心找到有关如何编写好答案的更多信息。 - Community