Skip to content

Add hide_versions_dropdown option#551

Merged
dgarcia360 merged 3 commits intoscylladb:masterfrom
dgarcia360:hide-all-versions-multiversion
Aug 19, 2022
Merged

Add hide_versions_dropdown option#551
dgarcia360 merged 3 commits intoscylladb:masterfrom
dgarcia360:hide-all-versions-multiversion

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

Adds a new option to completely disable the version selector in projects such as scylla cloud.

How to test this PR

  1. In conf.py, add the following option under html_theme_options:
html_theme_options = {
    "hide_versions_dropdown": "true",
}
  1. Run make multiversionpreview and open http://localhost:5500/master/getting-started/. The multiversion selector should not appear.

@dgarcia360 dgarcia360 added the enhancement New feature or request label Aug 16, 2022
@annastuchlik
Copy link
Copy Markdown
Collaborator

@dgarcia360 I've approved it because the option works as expected and the drop-down is hidden when that option is set to true.
There were two warnings - I don't think they are related to this PR, but could you check?

WARNING: autodoc: failed to import module 'redirects' from module 'sphinx_scylladb_theme.extensions'; the following exception was raised:
No module named 'sphinx_scylladb_theme.extensions.redirects'
WARNING: autodoc: failed to import module 'substitutions' from module 'sphinx_scylladb_theme.extensions'; the following exception was raised:
No module named 'sphinx_scylladb_theme.extensions.substitutions'

@dgarcia360 dgarcia360 merged commit e305029 into scylladb:master Aug 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants