ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Labels

Caution

You're viewing documentation for a previous 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
Images
NEXT
Links
  • Create an issue
  • Edit this page

On this page

  • Labels
    • Syntax
    • Usage Beta
      • Default
      • Inlined with text
        • Heading Beta
ScyllaDB Sphinx Theme
  • 1.3
    • 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
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.2 to 1.3
    • 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
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 01 Apr 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI