Admonitions¶
These are coloured boxed useful to highlight information.
List of admonitions¶
admonition¶
Example
This is an admonition block named example. You can choose the title.
attention¶
Attention
This is an attention block.
caution¶
Caution
This is a caution block.
danger¶
Danger
This is a danger block.
error¶
Error
This is an error block.
hint¶
Hint
This is a hint block.
important¶
Important
This is an important block.
note¶
Note
This is a note block.
seealso¶
See also
This is a seealso block.
tip¶
Tip
This is a tip block.
todo¶
Todo
This is a todo block. It needs the sphinx.ext.todo extension.
todo blocks can be useful to track missing things. They can be swithced off in conf.py with
todo_include_todos = False
So if you don’t see the todo above, this is why.
warning¶
Warning
This is a warning block.
Describing changes between versions¶
The following admonition blocks are useful to highlight changes between versions of Yambo, for example if a feature is added or the name of an input variable is changed.
Added in version 5.0: Brief explanation.
Changed in version 5.0: Brief explanation.
Deprecated since version 5.0: Brief explanation.
Removed in version 5.0: Brief explanation.
Place this directives just before the related/affected content.
Note
In version 8.3 of sphinx the names of these directives have been changed to
version-added, version-changed, version-deprecated, version-removed.
See here.
Collapsible option¶
From version 8.2 of sphinx each admonition directive supports a :collapsible: option. See here.
Note
Collapsible directives look a bit ugly tho (at least with Furo…)
Even if :collapsible: is the default way to do this, the sphinx-togglebutton extension (documentation here) allows to add :class: dropdown to the admonition:
Caution
This looks way better, but it also requires sphinx-design!
A different way to collapse text is provided by dropdowns.
rST vs MD syntax¶
.. note::
:class: dropdown
content
```{note}
:class: dropdown
content
```