Caution
You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.
At Scylla, we limit the admonitions. Although restructuredText will allow for more, use the following:
Use a note to point out something to the reader. This action does not have any risk.
.. note:: text follows here
Renders as:
Note
text follows here
Use caution if there is any potential risk to data loss or lower performance.
.. caution:: look out
Renders as
Caution
look out
Use warning if there is any potential risk to total data loss or physical danger.
.. warning:: take care
Renders as:
Warning
take care
This is a time-saving or performance enhancing option.
.. tip:: here's a tip
Renders as:
Tip
here’s a tip
On this page