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

Caution

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

Examples¶

This guide covers the markup convention used for Scylla Docs. Our official documentation is written in RestructuredText. We will also accept content written in Markdown.

This guide covers the RestructuredText elements. If you are not familiar with RestructuredText, refer to this cheat sheet. Keep in mind, that in this cheat sheet there may be directives or elements of the markup we’re not using.

In general, there are main components to the markup of any document:

Components
  • Admonitions

  • Collapse

  • Code Blocks

  • Glossary

  • Headings

  • Hero Box

  • Images

  • Includes

  • Links

  • Lists

  • Markdown

  • Metadata

  • Panel Box

  • Substitutions

  • Tables

  • Tabs

  • Text

  • Toc

  • Topic Box

  • Versions

  • 404 Page

Was this page helpful?

PREVIOUS
Commands
NEXT
Admonitions
  • Create an issue
  • Edit this page
ScyllaDB Sphinx Theme
  • 1.1
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting Started
    • Toolchain
    • Installation
  • Configuration
    • Template Options
    • Multiversion Options
    • Troubleshooting
  • Commands
  • Examples
    • Admonitions
    • Collapse
    • Code Blocks
    • Glossary
    • Headings
    • Hero Box
    • Includes
    • Images
    • Links
    • Lists
    • Markdown Support
    • Metadata
    • Panel Box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic Box
    • Versions
  • Upgrade Guides
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the Documentation
    • Contribute to the Sphinx 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