Guides

Admonitions

Admonitions are blocks of text that are rendered in a special way to draw attention to them. They are often used to provide additional information to the reader about the content that is being discussed.

AttentionDirective

Directive to create an attention admonition.

Example:

 .. attention::

     This is an attention admonition.

CautionDirective

Directive to create a caution admonition.

Example:

 .. caution::

     This is a caution admonition.

DangerDirective

Directive to create a danger admonition.

Example:

 .. danger::

     This is a danger admonition.

ErrorDirective

Directive to create a error admonition.

Example:

 .. error::

     This is an error admonition.

HintDirective

Directive to create a hint admonition.

Example:

 .. hint::

     This is a hint admonition.

ImportantDirective

Directive to create a important admonition.

Example:

 .. important::

     This is a important admonition.

NoteDirective

Directive to create a note admonition.

Example:

 .. note::

     This is a note admonition.

SeeAlsoDirective

Directive to create a seealso admonition.

Example:

 .. seealso::

     This is a seealso admonition.

TipDirective

Directive to create a tip admonition.

Example:

 .. tip::

     This is a tip admonition.

WarningDirective

Directive to create a warning admonition.

Example:

 .. warning::

     This is a warning admonition.

Search results