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

disable docs navigation with keys #639

Merged
merged 1 commit into from
Jan 14, 2024
Merged

Conversation

bjlittle
Copy link
Owner

@bjlittle bjlittle commented Jan 14, 2024

🚀 Pull Request

Description

This pull-request addresses the following sphinx-book-theme warning by disabling
navigation with keys, as recommended.

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

@github-actions github-actions bot added the type: documentation Auto-labelled for doc/* and docs/* branches label Jan 14, 2024
Copy link

codecov bot commented Jan 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (fdd6565) 94.93% compared to head (641d886) 94.93%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #639   +/-   ##
=======================================
  Coverage   94.93%   94.93%           
=======================================
  Files         125      125           
  Lines        4778     4778           
=======================================
  Hits         4536     4536           
  Misses        242      242           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bjlittle bjlittle merged commit 5ac1008 into main Jan 14, 2024
20 checks passed
@bjlittle bjlittle deleted the docs-navigation-with-keys branch January 14, 2024 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation Auto-labelled for doc/* and docs/* branches
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant