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 Metadata

Caution

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

Metadata¶

Add the following annotations at the beggining of .rst files to customize the layout of a specific page.

Description¶

Adds a description to a document. This description is mainly used for Search Engine Optimization.

.. meta::
   :description: The reStructuredText plaintext markup language
   :keywords: plaintext, markup language

This would be converted to the following HTML:

<meta name="description"
   content="The reStructuredText plaintext markup language">
<meta name="keywords" content="plaintext, markup language">

Full width¶

If set, hides boths sidenavs and makes the content full-width.

:full-width:

Landing page¶

If set, removes all internal paddings from the page.

:landing:

Hide version warning¶

If set, hides the version warning from the page.

:hide-version-warning:

Hide pre content¶

If set, hides the breadcrumbs and contribute button from the page.

:hide-pre-content:

Hide post content¶

If set, hides the prev / next navigation buttons from the page.

:hide-post-content:

Was this page helpful?

PREVIOUS
Markdown Support
NEXT
Panel Box
  • Create an issue
  • Edit this page

On this page

  • Metadata
    • Description
    • Full width
    • Landing page
    • Hide version warning
    • Hide pre content
    • Hide post content
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