Admonitions

Tests the full set of admonition styles, plus custom titles and dropdown (togglebutton) behaviour.

Note

Note

This is a standard note. It contains a paragraph of prose, bold and italic emphasis, and inline code.

Warning

Warning

A warning admonition signals that something can go wrong. It should render with a distinct (typically amber or red) accent.

Tip

Tip

A tip is a softer call-out — often used for “good to know” pointers that aren’t strictly necessary to read.

Important

Important

An important admonition flags information the reader should not skip over.

Danger

Danger

A danger admonition signals critical risk — typically rendered with the strongest red treatment.

Attention

Attention

An attention admonition. Visually similar to warning in most themes but semantically distinct.

Caution

Caution

A caution admonition.

Error

Error

An error admonition, often used inline to flag code-like failure cases.

Hint

Hint

A hint admonition. Common in exercises to nudge the reader without giving away the answer.

Seealso

See also

A seealso admonition points to related material. Often contains links.

• The math fixture

• The cross-references fixture

Custom title

A custom title goes here

The admonition directive with an explicit title and class is a flexible escape hatch when the built-in categories don’t fit.

Dropdown (sphinx-togglebutton)

Click to reveal

This admonition is collapsed by default. The dropdown chevron should render in the title bar, and the body should expand on click without layout shift elsewhere on the page.

Admonition with rich content

Note

Admonitions can contain rich content:

• Lists

• inline code

• Math like \(e^{i\pi} + 1 = 0\)

• Code blocks:

  print("hello from inside an admonition")
  

• And links to other pages.

Multiple admonitions in sequence

Tip

First admonition.

Warning

Second admonition immediately after — vertical spacing between adjacent admonitions matters.

Note

Third admonition.