Comment incorporer des images dans des documents sphinx?

Question

Je suis assez nouveau dans l'utilisation de sphinx, Faire de la documentation pour la première fois pour le projet python. Comment intégrer l'image par exemple dans la documentation de sphinx?

Answer 1

Utilisez la directive image, par exemple:

.. image:: example.png

Le chemin d'accès à l'image est relatif au fichier. Voir documentation Sphinx pour plus d'informations.

Answer 2

De la documentation :

Il existe deux directives d'image: image et figure.

Un image est une image simple.

Un figure se compose de données d'image (y compris les options d'image), d'une légende facultative (un seul paragraphe) et d'une légende facultative (éléments de corps arbitraires). Pour les supports de sortie basés sur des pages, les chiffres peuvent flotter vers une position différente si cela aide la mise en page.

Exemple d'utilisation de image:

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

Exemple d'utilisation de figure:

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

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