KATO Tomoyuki f06e866917 [contributor] reorganize RST/JSON conventions
Change-Id: Idac1e6c049438819d5c363b694102c22d67fa19b
Implements: blueprint contributor-guide-reorg
2016-07-12 14:42:50 +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.