Admonitions
This page shows the available admonitions, or callouts, 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.
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.
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.
Caution
Use a caution
admonition to make the user aware of important issues,
or consequences.
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.
The danger
and error
admonitions are considered equivalent and appear in
the same style.
Blockquotes
Blockquotes 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