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

Warning raised during docs build #2405

Closed
purva-thakre opened this issue Jun 10, 2024 · 3 comments
Closed

Warning raised during docs build #2405

purva-thakre opened this issue Jun 10, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@purva-thakre
Copy link
Collaborator

While running make docs locally, the following warning was raised:

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

@purva-thakre purva-thakre added the bug Something isn't working label Jun 10, 2024
@purva-thakre
Copy link
Collaborator Author

purva-thakre commented Jun 12, 2024

I am not too sure if we need to worry about this warning. In my opinion, we could close this.

From my device, I cannot navigate to the previous or next page of the current documentation using ← and → keys on the keyboard.
https://pydata-sphinx-theme.readthedocs.io/en/v0.12.0/user_guide/keyboard-shortcuts.html#change-pages

@purva-thakre purva-thakre reopened this Jun 14, 2024
@purva-thakre purva-thakre closed this as not planned Won't fix, can't repro, duplicate, stale Jun 14, 2024
@purva-thakre purva-thakre reopened this Jun 21, 2024
@purva-thakre
Copy link
Collaborator Author

purva-thakre commented Jun 21, 2024

Reopening this because I misunderstood the warning. Indeed we can see this in the docs. If I go directly to the API age, and hit the right or left key on the keyboard it won't do anything.

If I keyword search for represent_operation_with_global_depolarizing_noise on the API page, the page can suddenly move behind the left sidebar if I keep hitting the left arrow on the keyboard.

left_right_arrows.mp4

This is partially related to #2331 (comment) where we should get rid of the blank sidebar on the left.

Edit: I do not think the behavior I see can be fixed with "navigation_with_keys": False.

@purva-thakre
Copy link
Collaborator Author

Closing as discussed in the Description section of #2424

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant