Admonitions#

Sphinx provides several different types of admonitions.

topic#

This is a topic.

This is what admonitions are a special case of, according to the docutils documentation.

admonition#

The one with the custom titles

It’s got a certain charm to it.

attention#

Attention

Climate change is real.

caution#

Caution

Cliff ahead: Don’t drive off it.

danger#

Danger

Mad scientist at work!

error#

Error

Does not compute.

hint#

Hint

Insulators insulate, until they are subject to ______ voltage.

important#

Important

Tech is not neutral, nor is it apolitical.

note#

Note

This is a note.

seealso#

See also

Other relevant information.

tip#

Tip

25% if the service is good.

todo#

Todo

This needs the sphinx.ext.todo extension.

warning#

Warning

Reader discretion is strongly advised.

versionadded#

New in version v0.1.1: Here’s a version added message.

versionchanged#

Changed in version v0.1.1: Here’s a version changed message.

deprecated#

Deprecated since version v0.1.1: Here’s a deprecation message.