OlgaGusarenko c10da1ec38 [Contributor Guide] RST section finished

1. Adds the following subsections:
   * Introduction to RST
   * Tables
   * Images
   * Profiling
   * Lists
   * Inline markups
   * Decorations
   * Commenting
2. Restructures the toc
3. Creates separate files for each subsection included in the
RST-related folder for simpler maintenance.

Change-Id: I08568fb37755109552edf9692b8f259660550a69

2015-10-20 11:14:32 +03:00

1.2 KiB

Raw Blame History

Specific information blocks

Use special markups to emphasize specific information within your document. Depending on specific semantic meaning of the message, you can use:

note - for a message of generic meaning.
warning or important - includes details that can be easily missed, but should not be ignored by a user and are valuable before proceeding.
caution - delivers information that prevents a user from mistakes and undesirable consequences when following the procedures.
tip - wraps extra but helpful information.

Here is the example of the note directive usage; these can be applied to all the admonition directives described above.

Input

.. note::

   This is the text of a generic admonition.
   This line is the continuation of the first line.

   A note may contain bulleted or enumerated lists,
   as well as code blocks:

   * first option,
   * ...

Output

Note

This is the text of a note admonition. This line is the continuation of the first line.

Note may contain bulleted or enumerated lists, as well as code blocks:

first option,
...

1.2 KiB Raw Blame History

Specific information blocks

1.2 KiB

Raw Blame History