Notes, warnings, and quotations

You can use one of the following directives to mark up additional information. These elements are often called admonitions or call-outs.


Tips

You can use the tip directive to highlight information that has a positive effect for the user. For example, a tip can be a shortcut or a confirmation.

Tip

This is how a tip appears.

You can also use the hint element, which appears in the same style.

Hint

Hints and tips appear in the same style.

Notes

You can use the note directive to provide extra information.

Note

This is how a note appears.

To include a list of references, you can use the seealso directive.

You can also create notes with custom titles. Use the admonition directive:

rst
.. admonition:: How to give a note a custom title?

   Enter the custom title after after the ``admonition`` directive.

This gets rendered as:

How to give a note a custom title?

Enter the custom title after the admonition directive.

Cautions

You can use a caution directive to alert the user about important issues.

Caution

This is how a caution appears.

You can also use the important directive, which appears in the same style.

Important

Important and caution call-outs appear in the same style.

Warnings

You can use the warning directive to warn the user about negative consequences. For example, anything involving security should be emphasized with a warning.

Warning

This is how a warning appears.

You can also use the danger and error directives, which appear in the same style.

Danger

This is how a potentially dangerous step appears.

Warning

This is how a warning appears.

Block quotations

You can use block quotations to highlight quotes.

“It is my business to know things. That is my trade.”

—Sherlock Holmes