Wie können wir Bilder in Sphinx-Dokumente einbetten?

Question

Ich bin ziemlich neu in der Verwendung von Sphinx, Doing Dokumentation zum ersten Mal für das Python-Projekt. Wie man Bild zum Beispiel in die Sphinx-Dokumentation einbetten?

Answer 1

Vom documenation:

Es gibt zwei Bild Richtlinien: image und figure.

Ein image ist ein einfaches Bild.

Ein figure besteht aus Bilddaten (einschließlich Bildoptionen), einer optionalen Beschriftung (einem einzelnen Absatz) und einer optionalen Legende (beliebige Körperelemente). Bei seitenbasierten Ausgabemedien können Abbildungen an eine andere Position verschoben werden, wenn dies dem Seitenlayout hilft.

Beispiel für image Nutzung:

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

Beispiel für figure Nutzung:

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

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

Answer 2

Verwenden Sie die image Richtlinie, zum Beispiel:

.. image:: example.png 

Der Pfad zum Bild in der Datei ist relativ. Weitere Informationen finden Sie unter Sphinx documentation.