python-sphinx - how - sphinx software

¿Cómo podemos incrustar imágenes en documentos de esfinge?

Question

Soy bastante nuevo en el uso de la esfinge, haciendo documentación por primera vez para el proyecto de Python. ¿Cómo incrustar la imagen, por ejemplo, en la documentación de la esfinge?

Answer 1

De la documenation :

Hay dos directivas de image : image y figure .

Una image es una imagen simple.

Una figure consta de datos de imagen (incluidas las opciones de imagen), un título opcional (un solo párrafo) y una leyenda opcional (elementos de cuerpo arbitrario). Para los medios de salida basados ​​en páginas, las cifras pueden flotar a una posición diferente si esto ayuda al diseño de la página.

Ejemplo para el uso de la image :

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

Ejemplo para el uso de figure :

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

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

Answer 2

Utilice la directiva de image , por ejemplo:

.. image:: example.png

La ruta a la imagen es relativa al archivo. Consulte la documentación de Sphinx para más información.