Admonitions#
Important
The examples are taken from the original documentation of the Sphinx book theme, available at their website.
The syntax to use admonitions is the following:
::::::{class}
<content>
::::::
where class is the type of admonition used, and <content> is what will be inside the admonition. In this chapter we present classes of admonitions available, and their styling in the TU Delft theme.
topic#
::::::{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.
::::::{admonition} The one with the custom titles
It's got a certain charm to it.
::::::
attention#
Attention
Climate change is real.
::::::{attention}
Climate change is real.
::::::
caution#
Caution
Cliff ahead: Don’t drive off it.
::::::{caution}
Cliff ahead: Don't drive off it.
::::::
danger#
Danger
Mad scientist at work!
::::::{danger}
Mad scientist at work!
::::::
error#
Error
Does not compute.
::::::{error}
Does not compute.
::::::
hint#
Hint
Insulators insulate, until they are subject to ______ voltage.
::::::{hint}
Insulators insulate, until they are subject to ______ voltage.
::::::
important#
Important
Tech is not neutral, nor is it apolitical.
::::::{important}
Tech is not neutral, nor is it apolitical.
::::::
note#
Note
This is a note.
::::::{note}
This is a note.
::::::
seealso#
See also
Other relevant information.
::::::{seealso}
Other relevant information.
::::::
tip#
Tip
25% if the service is good.
::::::{tip}
25% if the service is good.
::::::
warning#
Warning
Reader discretion is strongly advised.
::::::{warning}
Reader discretion is strongly advised.
::::::
versionadded#
Added in version v0.1.1: Here’s a version added message.
::::::{versionadded} v0.1.1
Here's a version added message.
::::::
versionchanged#
Changed in version v0.1.1: Here’s a version changed message.
::::::{versionchanged} v0.1.1
Here's a version changed message.
::::::
deprecated#
Deprecated since version v0.1.1: Here’s a deprecation message.
::::::{deprecated} v0.1.1
Here's a deprecation message.
::::::