openstack-manuals/doc/doc-contrib-guide/source/rst-conv/figures.rst
Alexandra Settle 85107272be [contrib-guide] Updating url to doc-contrib-guide
Based off conversation at the PTG, we agreed it would be
beneficial to ensure the contrib-guide is clearly marked
as the doc contrib guide outside of the title.

This change includes a redirect.

Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
2017-09-22 14:57:47 +00:00

853 B

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.

For the style guidelines on figure titles, see figure_table_titles.