Admonitions¶

A Sphinx admonition consist of three elements:

the type of the admonition,
An optional title, and
the body, which is normally text.

Sphinx supports the following types of admonitions: attention, caution, danger, error, hint, important, note, tip, warning.

Admonitions are written like this in reStructuredText:

.. type::

    Text of the admonition

Or like this in Markdown:

:::{type}
Notes can provide complementary information.
:::

Be aware that Markdown examples in this page are using "colon_fence". Read about it here.

In both cases replace the type with any of the possible type of admonitions: admonition (for custom admonitions with title), attention, caution, danger, error, hint, important, note, tip and warning.

Type: admonition¶

A custom admonition displayed as a note and with a title:

Markdown

:::{admonition} The missing note G
:class: note
You will receive an error message in the future.
:::

reStructuredText

.. admonition:: The missing note G
    :class: note

    There never was a Note G. I do not know why I chose H instead
    of G, & thus insulted the latter worthy letter. -- Ada Lovelace

The missing note G

There never was a Note G. I do not know why I chose H instead of G, & thus insulted the latter worthy letter. – Ada Lovelace

Type: attention¶

A sample attention admonition:

Markdown

:::{attention}
Windows has detected that you have moved your mouse.
Please, restart your computer.
:::

reStructuredText

.. attention::

    Windows has detected that you have moved your mouse.
    Please, restart your computer.

Attention

Windows has detected that you have moved your mouse. Please, restart your computer.

Type: caution¶

A sample caution admonition:

Markdown

:::{caution}
I have not had my coffee yet.
:::

reStructuredText

.. caution::

    I have not had my coffee yet.

Caution

I have not had my coffee yet.

Type: danger¶

A sample danger admonition:

Markdown

:::{danger}
If you click Ok all your files will be deleted.
Be aware that there is no way to recover them.
:::

reStructuredText

.. danger::

    If you click Ok all your files will be deleted.
    Be aware that there is no way to recover them.

Danger

If you click Ok all your files will be deleted. Be aware that there is no way to recover them.

Type: error¶

A sample error admonition:

Markdown

:::{error}
Your computer has been running for 10h 37m 23s.
Microsoft does not allow a windows system to run
longer than that. Your computer will now crash.
:::

reStructuredText

.. error::

    Your computer has been running for 10h 37m 23s.
    Microsoft does not allow a windows system to run
    longer than that. Your computer will now crash.

Error

Your computer has been running for 10h 37m 23s. Microsoft does not allow a windows system to run longer than that. Your computer will now crash.

Type: important¶

A sample important admonition:

Markdown

:::{important}
I am on a Zoom call, Please, do not walk out naked!
:::

reStructuredText

.. important::

    I am on a Zoom call, Please, do not walk out naked!

Important

I am on a Zoom call, Please, do not walk out naked!

Type: note¶

A sample note admonition:

Markdown

:::{note}
Sending the file will not take too long, just 8.752.239.254 seconds.
:::

reStructuredText

.. note::

    Sending the file will not take too long, just 8.752.239.254 seconds.

Note

Sending the file will not take too long, just 8.752.239.254 seconds.

Type: tip¶

A sample tip admonition:

Markdown

:::{tip}
Windows 95 was unable to detect your keyboard.
Press F1 to retry or F2 to abort.
:::

reStructuredText

.. tip::

    Windows 95 was unable to detect your keyboard.
    Press F1 to retry or F2 to abort.

Tip

Windows 95 was unable to detect your keyboard. Press F1 to retry or F2 to abort.

Type: warning¶

A sample warning admonition:

Markdown

:::{warning}
You will receive an error message in the future.
:::

reStructuredText

.. warning::

    You will receive an error message in the future.

Warning

You will receive an error message in the future.