unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
344 stars 145 forks source link

Warning raised during docs build #2405

Closed purva-thakre closed 4 days ago

purva-thakre commented 3 weeks ago

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

purva-thakre commented 2 weeks ago

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 commented 1 week ago

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.

https://github.com/unitaryfund/mitiq/assets/66048318/3bbc41b8-d181-4da7-8c4f-e8a19e81d0ba

This is partially related to https://github.com/unitaryfund/mitiq/issues/2331#issuecomment-2176567908 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 commented 4 days ago

Closing as discussed in the Description section of #2424