Come incorporiamo le immagini nei documenti sfinge?

Question

Sono abbastanza nuovo nell'usare la sfinge, facendo documentazione per la prima volta per il progetto python. Come incorporare l'immagine per esempio nella documentazione della sfinge?

Answer 1

Dal documenation:

Ci sono due direttive immagine: image e figure.

Un image è un'immagine semplice.

A A figure consiste di dati immagine (incluse le opzioni immagine), una didascalia opzionale (un singolo paragrafo) e una legenda opzionale (elementi del corpo arbitrari). Per i media di output basati su pagina, le figure potrebbero essere spostate in una posizione diversa se questo aiuta il layout della pagina.

Esempio per image utilizzo:

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

Esempio per figure utilizzo:

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

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

Answer 2

utilizzare la direttiva image, ad esempio:

.. image:: example.png 

Il percorso dell'immagine è relativo al file. Vedere lo Sphinx documentation per ulteriori informazioni.