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 a previous version of Scylla Sphinx Theme. Switch to the latest stable version.

Scylla Sphinx Theme Examples Panel Box

Panel Box¶

A custom directive to creates boxes on subordinate index.rst files.

Warning

Do not use the panel-box on the root index.rst.

Syntax¶

.. panel-box::
   <options>

   <text>

Options¶

The topic-box directive supports the following options:

Option

Type

Required

Example Value

Description

title

string

Y

Lorem ipsum

Hero box title.

Usage¶

For example, using:

.. panel-box::
   :title: Admin

   Test

Results in:

Admin

Test

PREVIOUS
Metadata
NEXT
Substitutions
  • 1.1
    • 1.2
    • 1.1
    • 1.0
  • Getting Started
    • Toolchain
    • Installation
  • Configuration
    • Template Options
    • Multiversion Options
    • Troubleshooting
  • Commands
  • Deployment
  • 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
  • Create an issue
  • Edit this page

On this page

  • Panel Box
    • Syntax
    • Options
    • Usage
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon
© 2022, ScyllaDB. All rights reserved.
Last updated on 17 May 2022.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.2.2