Caution
You're viewing documentation for an unstable version of Scylla Sphinx Theme. Switch to the latest stable version.
The following options can be defined in the file conf.py
per project, using html_theme_options
setting.
Configuration options for the banner shown at the top of the page.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
Learn more |
Caption for the promotional banner call to action. |
|
string |
# |
Link for the promotional banner call to action. |
|
string |
Relative path to icon for the promotional banner. |
|
|
string |
Scylla University Live | Free Virtual Training Event |
Leading text shown in the promotional banner. |
|
string |
true |
Set to |
Example:
html_theme_options = {
'banner_button_text': 'Learn more',
'banner_button_url': '#',
'banner_icon_path': '_static/mascots/scylla-opensource.svg',
'banner_title_text': 'Scylla University Live | Free Virtual Training Event',
'hide_banner': 'true',
}
Configuration options for version dropdown.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
branch- |
Part of the branch name to skip from the multiversion dropdown. |
|
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. |
|
list of strings |
[] |
List of tags and branches names to hide from 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',
}
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': [],
}
Configuration options for the Contribute button.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
docs/source |
Relative path to conf.py file. |
|
string |
scylladb/scylla-doc-issues |
Repository organization name and project slug to report issues, separated by a slash (/). |
|
string |
Repository organization name and project slug where docs are hosted, separated by a slash (/). |
|
|
string |
true |
Set to |
Example:
html_theme_options = {
'conf_py_path': 'docs/source/',
'github_issues_repository': 'scylladb/sphinx-scylladb-theme',
'hide_edit_this_page_button': 'true',
}
Configuration options for the left sidebar.
Option |
Type |
Default Value |
Description |
---|---|---|---|
|
string |
false |
Set to true to remove the “>” icon next to each sidebar entry. |
|
number |
-1 |
The maximum depth of the sidebar nested entries. Set to -1 to allow unlimited depth. |
Example:
html_theme_options = {
'collapse_navigation': 'false',
'navigation_depth': '-1'
}
Configuration options for Search Engine Optimization.
Option |
Type |
Default Value |
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.',
}