Notes, warnings, and quotations
Use admonitions or callouts to mark up additional information.
Tips
Use the tip
directive to highlight information that has a positive effect for users.
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
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.
See also
To create notes with custom titles, use the admonition
directive:
.. admonition:: How to give a note a custom title?
Enter the custom title after after the ``admonition`` directive.
This renders as:
How to give a note a custom title?
Enter the custom title after the admonition
directive.
Cautions
Use a caution
directive to alert users 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 callouts appear in the same style.
Warnings
You can use the warning
directive to warn users about negative consequences.
For example, you should use a warning to call out anything involving security.
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.
Error
This is how an error appears.
Block quotations
You can use block quotations to highlight quotes.
“It is my business to know things. That is my trade.”
—Sherlock Holmes