ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu

Caution

You're viewing documentation for a previous version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

ScyllaDB Docs ScyllaDB Sphinx Theme Examples Admonitions

Admonitions¶

At Scylla, we limit the admonitions. Although restructuredText will allow for more, use the following:

  • Note

  • Caution

  • Warning

  • Tip

Note¶

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

Caution¶

Use caution if there is any potential risk to data loss or lower performance.

.. caution:: look out

Renders as

Caution

look out

Warning¶

Use warning if there is any potential risk to total data loss or physical danger.

.. warning:: take care

Renders as:

Warning

take care

Tip¶

This is a time-saving or performance enhancing option.

.. tip:: here's a tip

Renders as:

Tip

here’s a tip

PREVIOUS
Examples
NEXT
Collapse
ScyllaDB Sphinx Theme
  • 1.2
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
  • Create an issue
  • Edit this page

On this page

  • Admonitions
    • Note
    • Caution
    • Warning
    • Tip
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1