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

Caution

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

ScyllaDB Docs ScyllaDB Sphinx Theme Configuration Page options

Page options¶

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 displayed in search engines results page.

For example:

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

Results in the following HTML:

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

Full width¶

If set, makes the content full-width.

:full-width:

Landing page¶

If set, makes the content within the div with class landing_content float on top of the hero box.

:landing:

Hide pre content¶

If set, hides the breadcrumbs from the page.

:hide-pre-content:

Hide post content¶

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

:hide-post-content:

Hide sidebar¶

If set, hides the primary sidebar from the page.

:hide-sidebar:

Hide secondary sidebar¶

If set, hides the secondary sidebar from the page.

:hide-secondary-sidebar:

Hide version warning¶

If set, hides the version warning from the page.

:hide-version-warning:
PREVIOUS
Template options
NEXT
Multiversion options
ScyllaDB Sphinx Theme
  • master
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • 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.3 to 1.4
    • 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
  • Create an issue
  • Edit this page

On this page

  • Page options
    • Description
    • Full width
    • Landing page
    • Hide pre content
    • Hide post content
    • Hide sidebar
    • Hide secondary sidebar
    • Hide version warning
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1