Admonitions

This page shows the available admonitions for this theme.

Tips

Tips are positive admonitions. A tip can be a shortcut for an action that was further explained in the main text, or a confirmation.

Tip

This is how a tip appears.

The hint admonition is considered equivalent and appears in the same style.

Notes

Notes are neutral admonitions, that can draw the attention of the reader, but usually don’t have a positive or negative effect.

Note

This is how a note appears.

If you want to include a list of references to further documentation, you can use the seealso directive.

Use a general admonition for notes with custom titles.

How to give the admonition a title?

Provide the title directly after the directive, for example,

rst
.. admonition:: How to give the admonition a title?

Caution

Use a caution admonition to make the user aware of important issues, or consequences.

Caution

This is how a caution appears.

The important admonition is considered equivalent and appears in the same style.

Warning

A warning is a negative admonition. Typically, anything involving security should be emphasized with a warning. Ignoring the information in a warning usually has negative consequences.

Warning

This is how a warning appears.

The danger and error admonitions are considered equivalent and appear in the same style.

Block quotations

Block quotations aren’t admonitions, but are used to quote other material and as such are often set apart from the main text.

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

—Sherlock Holmes