Docs: Address warning from pydata-sphinx-theme
#978
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The warning read:
The default value for `navigation_with_keys` will change to `False`
in the next release. If you wish to preserve the old behavior for
your site, set `navigation_with_keys=True` in the `html_theme_options`
dict in your `conf.py` file. Be aware that `navigation_with_keys = True`
has negative accessibility implications:
pydata/pydata-sphinx-theme#1492
Here we set `navigation_with_keys=False` to avoid the negative
accessibility implications.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The warning read:
Here we set
navigation_with_keys=Falseto avoid the negative accessibility implications.