Was this page helpful?
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 |
---|---|---|---|
|
string |
true |
When set to |
|
string |
true |
Set to |
|
string |
List of custom warnings implemented by the theme to exclude, separated by commas. Available values are: |
Example:
html_theme_options = {
'scylladb_scripts': 'true',
}
Version dropdown options¶
Configuration options for version dropdown.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
branch- |
Part of the branch name to skip from the multiversion dropdown. |
|
list of strings |
[] |
List of tags and branches names to hide from the multiversion dropdown. |
|
string |
true |
Set to true to remove completely the multiversion dropdown. |
|
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 |
---|---|---|---|
|
list of strings |
[] |
List of versions (branches or tags) that are not released yet. |
|
list of strings |
[] |
List of deprecated versions (branches or tags). |
Example:
html_theme_options = {
'versions_unstable': ['master'],
'versions_deprecated': [],
}
SEO options¶
Configuration options for Search Engine Optimization.
Option |
Type |
Default Value |
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.',
}
Zendesk options¶
Configuration options for enabling zendesk.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
Zendesk verification tag. Example: |
html_theme_options = {
'zendesk_tag': 'gq6ltsh3nfex3cnwfy4aj9',
}
Multiversion options¶
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
Overrides the default redirection of the main domain when using multiversion. By default, it redirects to |