1.15. Admonitions¶

1.15.1. Generic Admonition¶

The Generic admonition is a simple titled admonition. The title may be anything the author desires. The author-supplied title is also used as a “classes” attribute value after being converted into a valid identifier form. As well as this implicitly behavior the :class: option value can set to any implemented specific type and overrides the computed “classes” attribute value.

.. admonition::¶

The example

.. admonition:: Neque porro quisquam
   :class: error

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

1.15.2. Specific Admonitions¶

Specific Admonitions are specially marked “topics” that can appear anywhere an ordinary body element can. Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type. The following admonition directives have been implemented.

Attention Admonition¶

.. attention::¶

The example

.. attention:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Attention

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Caution Admonition¶

.. caution::¶

The example

.. caution:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Caution

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Danger Admonition¶

.. danger::¶

The example

.. danger:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Danger

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Error Admonition¶

.. error::¶

The example

.. error:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Error

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Hint Admonition¶

.. hint::¶

The example

.. hint:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Hint

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Important Admonition¶

.. important::¶

The example

.. important:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Important

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Note Admonition¶

.. note::¶

For more details, see note directive.

The example

.. note:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Note

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Tip Admonition¶

.. tip::¶

The example

.. tip:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Tip

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

Warning Admonition¶

.. warning::¶

For more details, see warning directive.

The example

.. warning:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives

Warning

Neque porro quisquam

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus mattis commodo eros, quis posuere enim lobortis quis. Nullam ut tempus nibh.

1.15.3. Sphinx Additional Admonitions¶

Seealso Admonition¶

.. seealso::¶

Many sections include a list of references to module documentation or external documents. These lists are created using the seealso directive.

The example

.. seealso:: Neque porro quisquam

   Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus
   mattis commodo eros, quis posuere enim lobortis quis. Nullam ut
   tempus nibh.

Which gives