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 Configuration Template options

Caution

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

Template options¶

The following options can be defined in the file conf.py per project, using html_theme_options setting.

General options¶

General configuration options.

Option

Type

Default Value

Description

local_scripts

string

true

When set to true, this option enables the loading of the local-scripts.html file from the template. This file is customizable per project, providing a convenient way to insert project-specific tags and scripts.

scylladb_scripts

string

true

Set to true to load ScyllaDB JS specific scripts, including Google Tag Manager, Expertrec, and Zendesk configuration.

skip_warnings

string

List of custom warnings implemented by the theme to exclude, separated by commas. Available values are: document_has_underscores.

Example:

html_theme_options = {
    'scylladb_scripts': 'true',
}

Banner options¶

Configuration options for the banner shown at the top of the page.

Option

Type

Default Value

Description

banner_button_text

string

Learn more

Caption for the promotional banner call to action.

banner_button_url

string

#

Link for the promotional banner call to action.

banner_button_icon

string

Relative path to icon for the promotional banner.

banner_title_text

string

ScyllaDB University Live | Free Virtual Training Event

Leading text shown in the promotional banner.

hide_banner

string

true

Set to true to hide the promotional banner.

Example:

html_theme_options = {
    'banner_button_text': 'Learn more',
    'banner_button_url': '#',
    'banner_icon_path': '_static/mascots-2/default.svg',
    'banner_title_text': 'ScyllaDB University Live | Free Virtual Training Event',
    'hide_banner': 'true',
}

Version dropdown options¶

Configuration options for version dropdown.

Option

Type

Default Value

Description

branch_substring_removed

string

branch-

Part of the branch name to skip from the multiversion dropdown.

hide_version_dropdown

list of strings

[]

List of tags and branches names to hide from the multiversion dropdown.

hide_versions_dropdown

string

true

Set to true to remove completely the multiversion dropdown.

tag_substring_removed

string

-scylla

Part of the tag name to skip from the multiversion dropdown.

Example:

html_theme_options = {
    'branch_substring_removed': 'branch-',
    'default_branch': 'master',
    'hide_version_dropdown': ['master'],
    'tag_substring_removed': '-scylla',
}

Version warning options¶

Configuration options for version warning.

Option

Type

Default Value

Description

versions_unstable

list of strings

[]

List of versions (branches or tags) that are not released yet.

versions_deprecated

list of strings

[]

List of deprecated versions (branches or tags).

Example:

html_theme_options = {
    'versions_unstable': ['master'],
    'versions_deprecated': [],
}

Edit on this page button options¶

Configuration options for the Edit on this page button.

Option

Type

Default Value

Description

conf_py_path

string

docs/source

Relative path to conf.py file.

default_branch

string

master

Name of the default branch where changes are integrated. Used to create the URL for the “Edit on this page” button.

github_issues_repository

string

scylladb/scylla-doc-issues

Repository organization name and project slug to report issues, separated by a slash (/).

github_repository

string

Repository organization name and project slug where docs are hosted, separated by a slash (/).

github_label

string

documentation

Name of the label to be used when creating an issue on GitHub.

hide_edit_this_page_button

string

true

Set to true to hide the contribute button.

Example:

html_theme_options = {
    'conf_py_path': 'docs/source/',
    'github_issues_repository': 'scylladb/sphinx-scylladb-theme',
    'hide_edit_this_page_button': 'true',
}

Sidebar options¶

Configuration options for the left sidebar.

Option

Type

Default Value

Description

collapse_navigation

string

false

Set to true to remove the “>” icon next to each sidebar entry.

navigation_depth

number

-1

The maximum depth of the sidebar nested entries. Set to -1 to allow unlimited depth.

theme

string

product

The theme to use. Available values: open-source, enterprise, cloud, self-hosted, product.

Example:

html_theme_options = {
    'collapse_navigation': 'false',
    'navigation_depth': '-1',
    'theme': 'product',
}

SEO options¶

Configuration options for Search Engine Optimization.

Option

Type

Default Value

Description

site_description

string

ScyllaDB is an Apache Cassandra-compatible NoSQL data store that can handle 1 million transactions per second on a single server.

Short summary describing the site.

Example:

html_theme_options = {
    'site_description': 'Documentation toolchain for ScyllaDB projects.',
}

Feedback buttons options¶

Configuration options for the like and dislike buttons shown at the bottom of the page.

Option

Type

Default Value

Description

hide_feedback_buttons

string

true

Set to true to display the like and dislike buttons at the bottom of the page.

html_theme_options = {
    'hide_feedback_buttons': 'true',
}

Zendesk options¶

Configuration options for enabling zendesk.

Option

Type

Default Value

Description

zendesk_tag

string

Zendesk verification tag. Example: gq6ltsh3nfex3cnwfy4aj9.

html_theme_options = {
    'zendesk_tag': 'gq6ltsh3nfex3cnwfy4aj9',
}

Multiversion options¶

Option

Type

Default Value

Description

redirect

string

Overrides the default redirection of the main domain when using multiversion. By default, it redirects to <DOMAIN>/stable/. Overriding setting this can be useful if the main domain page publishes multiple documentation sets. Example: /manual/stable/.

Was this page helpful?

PREVIOUS
Configuration
NEXT
Page options
  • Create an issue
  • Edit this page

On this page

  • Template options
    • General options
    • Banner options
    • Version dropdown options
    • Version warning options
    • Edit on this page button options
    • Sidebar options
    • SEO options
    • Feedback buttons options
    • Zendesk options
    • Multiversion options
ScyllaDB Sphinx Theme
  • master
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • AI chatbot support (beta)
    • Search support
    • Dependabot support
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
    • Centralized publication
  • Examples
    • Admonitions
    • Alert
    • Collapse
    • Code blocks
    • Diagrams
    • Glossary
    • Headings
    • Hero box
    • Icons
    • Images
    • Includes
    • Labels
    • Links
    • Lists
    • Mascots
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Tooltips
    • Topic box
    • Versions
  • Upgrade guides
    • Upgrading from 1.7 to 1.8
    • Upgrading from 1.6 to 1.7
    • Upgrading from 1.5 to 1.6
    • Upgrading from 1.4 to 1.5
    • Upgrading from 1.3 to 1.4
    • Upgrading from 1.2 to 1.3
    • Upgrading from 1.1 to 1.2
    • Upgrading from 1.0 to 1.1
    • Upgrading from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the 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 09 May 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI