Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue #157
Adds the new template option
hide_version_dropdown
, which hides a list of tags and branch names from the multi-version dropdown.For example, if a docs maintainer wants to build docs for the master branch, but does not want to remove
master
from the sidebar dropdown, they can define inconf.py
:Once we release this change, I'll go project by project to make sure they are building docs for the default branch and to set up this new option.
How to test this PR
In
conf.py
, replaceBRANCHES = ['master']
withBRANCHES = ['master', 'new-design']
to build docs for multiple versions.Then, add the new option
hide_version_dropdown': ['new-design']
underhtml_theme_options
. For example:After running
make multiversionpreview
, you should see in the dropdown only the option "master", but not "new-design".