Comment Pouvons-nous intégrer des images dans sphinx docs?

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

25
demandé sur mzjn 2014-09-16 14:14:48

2 réponses

À partir de la documentation :

Il y a 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 une page, les chiffres peuvent flotter à une position différente si cela aide la mise en page.

Exemple pour image utilisation:

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

Exemple pour figure utilisation:

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

   This is the caption of the figure (a simple paragraph).
28
répondu Jacek Krawczyk 2017-07-04 01:35:29

Utilisez la directive image, par exemple: 

.. image:: example.png

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

12
répondu devin_s 2014-09-16 22:52:12