Admonitions

Admonitions#

Note

This page contains only excerpts from my frequently used syntax. For the full documentation, please see {book}theme.


Admonition types#

Topics#

custom title

Let’s give readers a helpful hint!

Tip

Let’s give readers a helpful hint!

Attention

Let’s give readers a helpful hint!

Caution

Let’s give readers a helpful hint!

Danger

Let’s give readers a helpful hint!

Error

Let’s give readers a helpful hint!

Hint

Let’s give readers a helpful hint!

Important

Let’s give readers a helpful hint!

Note

Let’s give readers a helpful hint!

See also

Let’s give readers a helpful hint!

Warning

Let’s give readers a helpful hint!

Admotion Syntax#
    :::{tip}
        your_text
    :::

Container#

Sphinx also adds a number of additional admonition types, for denoting changes to the documentation, or to the codebase:

Added in version 1.2.3: Explanation of the new feature.

Changed in version 1.2.3: Explanation of the change.

Deprecated since version 1.2.3: Explanation of the deprecation.

Admotion Syntax#
    :::{versionadded} 1.2.3
    new: versionadded
    changed: versionchanged
    deprecated: deprecated
    :::

Other Containers#

Card#

Card

Header

Card Title

Card content

Footer

Admotion Syntax#
    :::{card} Card Title
    Header
    ^^^
    Card content
    +++
    Footer
    :::

Tab-Set#

Tab-Set

Content 1

Content 2

Admotion Syntax#
    ::::{tab-set}
    
    :::{tab-item} Label1
    Content 1
    :::
    
    :::{tab-item} Label2
    Content 2
    :::
    
    ::::
Contents