Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs fail to build because of the new PyData Theme navigation_with_keys warning #1229

Closed
jtpio opened this issue Oct 26, 2023 · 0 comments · Fixed by #1230
Closed

Docs fail to build because of the new PyData Theme navigation_with_keys warning #1229

jtpio opened this issue Oct 26, 2023 · 0 comments · Fixed by #1230
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@jtpio
Copy link
Member

jtpio commented Oct 26, 2023

Problem

In #1227 the docs fail to build because of the following warning:

WARNING: 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:https://github.com/pydata/pydata-sphinx-theme/issues/1492

image

Suggested Improvement

We can set the default to False as suggested and because the theme defaults to False if not specified:

"navigation_with_keys": False

Related PR: pydata/pydata-sphinx-theme#1503

@jtpio jtpio added the documentation Improvements or additions to documentation label Oct 26, 2023
@jtpio jtpio added this to the 0.2.0 milestone Oct 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant