Как мы вставляем изображения в документы sphinx?

Я новичок в использовании sphinx, впервые выполнив документацию для проекта python. Как вставить изображение, например, в документацию sphinx?

Ответ 1

Из documenation:

Существует два директивы изображения: image и figure.

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

Ответ 2

Используйте директиву image, например:

.. image:: example.png

Путь к изображению относится к файлу. Дополнительную информацию см. В документации Sphinx.