Sphinx ScyllaDB Theme 1.0 is now released 🥳
Learn more
Menu

Template Options

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

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.

default_branch

string

master

Name of the default branch where changes are integrated. Used to display the “You are not reading the most current version of the documentation” warning.

hide_version_dropdown

list of strings

[]

List of tags and branches names to hide from 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',
}

Contribute button options

Configuration options for the Contribute button.

Option

Type

Default Value

Description

conf_py_path

string

docs/source

Relative path to conf.py file.

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 (/).

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',
}

SEO options

Configuration options for Search Engine Optimization.

Option

Type

Default Value

Description

site_description

string

Scylla 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 Scylla projects.',
}