Was this page helpful?
Images¶
There are two possible directives for images. One is the image directive and the other is the figure directive. Refer to DocUtils for more options.
.. image:: images/checkmark.png
:alt: checkmark
renders the image
Whereas the figure directive allows you to use captions.
.. figure:: images/checkmark.png
:alt: checkmark
This is the caption for the image
Renders the image as:
This is the caption for the image¶
Resize images¶
You can resize images (and figures) with the option width.
When a reader clicks on an image with this option set, the image opens in a popup in full size.
This is handy when images are too small to be read from the documentation page.
For example:
.. figure:: images/diagram.svg
:width: 150px
.. image:: images/checkmark.png
:width: 150px
Renders the image as:
Click on the image to preview it in full size.