Admonitions

Admonitions#

Sphinx provides several different types of admonitions.

topic#

admonition#

The one with the custom titles

It’s got a certain charm to it.

We also support italic, bold, code, links, and more.

attention#

Attention

Climate change is real.

We also support italic, bold, code, links, and more.

caution#

Caution

Cliff ahead: Don’t drive off it.

We also support italic, bold, code, links, and more.

danger#

Danger

Mad scientist at work!

We also support italic, bold, code, links, and more.

error#

Error

Does not compute.

We also support italic, bold, code, links, and more.

hint#

Hint

Insulators insulate, until they are subject to ______ voltage.

We also support italic, bold, code, links, and more.

important#

Important

Tech is not neutral, nor is it apolitical.

We also support italic, bold, code, links, and more.

note#

Note

This is a note.

We also support italic, bold, code, links, and more.

seealso#

See also

Other relevant information.

We also support italic, bold, code, links, and more.

tip#

Tip

25% if the service is good.

We also support italic, bold, code, links, and more.

todo#

Todo

This needs the sphinx.ext.todo extension.

We also support italic, bold, code, links, and more.

warning#

Warning

Reader discretion is strongly advised.

We also support italic, bold, code, links, and more.

versionadded#

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

We also support italic, bold, code, links, and more.

versionchanged#

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

We also support italic, bold, code, links, and more.

deprecated#

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

We also support italic, bold, code, links, and more.

Contents