ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Deployments
    • Cloud
    • Server
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
    • Supported Driver Versions
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Install
Search Ask AI
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Labels

Caution

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

Labels¶

A custom role that lets you add labels to your text.

For example, you could use the label role to promote experimental features or highlight that a feature is only available in a specific software version.

Syntax¶

:label-<style>:`Text`

Where:

  • style: Available values are default, note, tip, caution, warning.

Usage Beta¶

Default¶

Using:

:label-default:`Default`, :label-note:`Note`, :label-tip:`Tip`, :label-caution:`Caution`, :label-warning:`Warning`

Results in:

Default, Note, Tip, Caution, Warning

Inlined with text¶

Using:

Heading :label-caution:`Beta`
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Results in:

Heading Beta¶

Was this page helpful?

PREVIOUS
Includes
NEXT
Links
  • Create an issue
  • Edit this page

On this page

  • Labels
    • Syntax
    • Usage Beta
      • Default
      • Inlined with text
        • Heading Beta
ScyllaDB Sphinx Theme
Search Ask AI
  • master
    • 1.9
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • AI chatbot support (beta)
    • Search support
    • Dependabot support
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
    • Centralized publication
  • Examples
    • Admonitions
    • Alert
    • API Documentation
      • Python
      • Doxygen
      • REST API (Redocly)
    • Collapse
    • Code blocks
    • Diagrams
    • Grid
    • Glossary
    • Headings
    • Hero box
    • Icons
    • Images
    • Includes
    • Labels
    • Links
    • Lists
    • Mascots
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Tooltips
    • Topic box
    • Versions
    • Videos
  • Upgrade guides
    • Upgrading from 1.8 to 1.9
    • Upgrading from 1.7 to 1.8
    • Upgrading from 1.6 to 1.7
    • Upgrading from 1.5 to 1.6
    • Upgrading from 1.4 to 1.5
    • Upgrading from 1.3 to 1.4
    • Upgrading from 1.2 to 1.3
    • Upgrading from 1.1 to 1.2
    • Upgrading from 1.0 to 1.1
    • Upgrading from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
Docs Tutorials University Contact Us About Us
© 2026 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 14 Apr 2026.
Powered by Sphinx 9.1.0 & ScyllaDB Theme 1.9.2