Admonitions

Admonitions are used to highlight or draw attention to specific information in a document. They are often used to provide additional context, warnings, or tips.

The following admonitions are available:

  • note

  • important

  • hint

  • tip

  • attention

  • warning

  • caution

  • danger

  • error

  • custom

Examples:

Admonition

Syntax

 
.. note::

   This is a note admonition.
 
.. important::

   This is a important admonition.
 
.. hint::

   This is a hint admonition.
 
.. tip::

   This is a tip admonition.
 
.. attention::

   This is a attention admonition.
 
.. warning::

   This is a warning admonition.
 
.. caution::

   This is a caution admonition.
 
.. danger::

   This is a danger admonition.
 
.. error::

   This is a error admonition.
 
.. admonition:: A Custom Admonition

   This is a custom admonition.