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

Caution

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

Scylla Sphinx Theme Examples

Examples¶

This documentation covers the markup convention used for Scylla Docs.

Our official documentation is written in restructuredText. 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

  • Panel box

  • Substitutions

  • Tables

  • Tabs

  • Text

  • Toc

  • Topic box

  • Versions

PREVIOUS
Pull requests previews
NEXT
Admonitions
  • master
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections 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
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 03 May 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.2.1