Figures¶
Use the figure
directive to include an image, figure, or screenshot into
the documentation.
The PNG image format is preferred over other image formats for all image files. If available the source files (SVG, OmniGraffle, ..) of generated image files should be provided. Formats editable by open sources tools are preferred.
Syntax
.. figure:: file_name.file_extension
:option: option_value
The figure directive supports the following options:
alt
height
figwidth
scale
align
target
figclass
For descriptions of the options and their possible values, refer to the Docutils documentation.
See also
For the style guidelines on figure titles, see Figure and table titles.