Tip
Admonitions can also be used before the first headline.
5 Admonitions#
5.1 Specific Admonitions#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#specific-admonitions
In many themes only note and warning are supported!
Attention
Attention text and inline code.
Caution
Caution text and inline code.
Danger
Danger text and inline code.
Error
Error text and inline code.
Hint
Hint text and inline code.
Important
Important text and inline code.
Note
Note text and inline code.
Tip
Tip text and inline code.
Warning
Warning text and inline code.
5.2 Generic Admonitions#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#generic-admonition
5.3 Topic#
https://docutils.sourceforge.io/docs/ref/rst/directives.html#topic
5.5 Admonition-like Constructs#
https://www.sphinx-doc.org/en/master/extdev/nodes.html#new-admonition-like-constructs
See also
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-seealso
and some inline code
See also
Text.
- Module
insipid_sphinx_theme Documentation of the
insipid_sphinx_thememodule.- Sphinx Documentation
Documentation for Sphinx.
Added in version 3.14: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionadded
Changed in version 3.14: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-versionchanged
Deprecated since version 3.14: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-deprecated
5.6 Nesting#
Note
Warning
This is a warning.
Note
Inner note text.
This is the warning again.
See also
Note
Note text.
Note
Admonition in a block quote.
5.7 Overflow#
A long long long long long long long long long long long long long long long long long long long long long long long long long long long admonition title
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
x |
