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.

Sign up for GitHub

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

Jump to bottom

the site intercepts the left and right arrow keys in order to navigate to the previous/next pages #1492

Closed
12rambau opened this issue Oct 4, 2023 · 1 comment · Fixed by #1503
Closed

the site intercepts the left and right arrow keys in order to navigate to the previous/next pages #1492

12rambau opened this issue Oct 4, 2023 · 1 comment · Fixed by #1503

Comments

@12rambau
Copy link
Collaborator

12rambau commented Oct 4, 2023 •
edited
Loading

Forgot to mention, the site intercepts the left and right arrow keys in order to navigate to the previous/next pages from the current page in the documentation. Tania and I have chatted about this before.
Probably a violation of WCAG 2.1.4 - Character Key Shortcuts (Level A)

Originally posted by @gabalafou in #1100 (comment)
@12rambau 12rambau changed the title the site intercepts the left and right arrow keys in order to navigate to the previous/next pages from the current page in the documentation. Tania and I have chatted about this before. the site intercepts the left and right arrow keys in order to navigate to the previous/next pages Oct 4, 2023
@gabalafou gabalafou mentioned this issue Oct 12, 2023
Merged
@gabalafou
Copy link
Collaborator

Another negative accessibility implication of this behavior, as discussed in #1100, is that it makes it really hard to make code cell blocks keyboard-accessible, because the standard way to scroll long lines in code cells with a keyboard is to use the left and right arrows.

The proposed solution is to disable the navigation_with_keys setting, which is documented in Sphinx under HTML Theming.

aknierim added a commit to aknierim/ctapipe that referenced this issue Oct 25, 2023
@aknierim
Fix navigation_with_keys warning
e4f3a9c 
Set navigation_with_keys to False to get rid of the
warning. Setting it to True has negative accessibility
implications: pydata/pydata-sphinx-theme#1492
maxnoe pushed a commit to aknierim/ctapipe that referenced this issue Oct 25, 2023
@aknierim @maxnoe
Fix navigation_with_keys warning
38d38d8 
Set navigation_with_keys to False to get rid of the
warning. Setting it to True has negative accessibility
implications: pydata/pydata-sphinx-theme#1492
@KumoLiu KumoLiu mentioned this issue Oct 25, 2023
Closed
christophfink added a commit to r5py/r5py that referenced this issue Oct 25, 2023
@christophfink
prepare for release v0.1.1 [skip ci] (#377)
c165f89 
* prepare for release v0.1.1 [skip ci]

* dependencies: sample data versions [skip ci]

* re: pydata/pydata-sphinx-theme#1492  [skip ci]
@CalMacCQ CalMacCQ mentioned this issue Oct 25, 2023
Merged
@coretl coretl mentioned this issue Oct 25, 2023
Merged
SMoraisAnsys added a commit to ansys/pyansys-dev-guide that referenced this issue Oct 26, 2023
@SMoraisAnsys
WIP: disable navigation_with_keys
db34932 
Problem
A warning is raised during workflow "Build project documentation".

Solution
Follow pydata/pydata-sphinx-theme#1492
instructions and disable "navigation_with_keys" as it is also something
that is defined as default for ansys sphinx theme (see
ansys/ansys-sphinx-theme#315)
SMoraisAnsys added a commit to ansys/pyansys-dev-guide that referenced this issue Oct 26, 2023
@SMoraisAnsys
WIP: disable navigation_with_keys
9613fa4 
Problem
A warning is raised during workflow "Build project documentation".

Solution
Follow pydata/pydata-sphinx-theme#1492
instructions and disable "navigation_with_keys" as it is also something
that is defined as default for ansys sphinx theme (see
ansys/ansys-sphinx-theme#315)
@alistairsellar alistairsellar mentioned this issue Oct 26, 2023
Merged
8 tasks
@flying-sheep flying-sheep mentioned this issue Oct 26, 2023
Merged
This was referenced Oct 26, 2023
Merged
Merged
@PetroBondar PetroBondar mentioned this issue Oct 26, 2023
Closed
amitschang added a commit to ssec-jhu/dplutils that referenced this issue Oct 26, 2023
@amitschang
Fix for pydata/pydata-sphinx-theme#1492
fb992d4
amitschang added a commit to ssec-jhu/dplutils that referenced this issue Oct 26, 2023
@amitschang
Fix for pydata/pydata-sphinx-theme#1492 (#10)
8f38594
anujsinha3 added a commit to anujsinha3/NoisePy that referenced this issue Oct 26, 2023
@anujsinha3
refactor: Fix navigation_with_keys warning.
bf24939 
Set navigation_with_keys to False to get rid of the warning. Setting it to True has negative accessibility implications: pydata/pydata-sphinx-theme#1492
SMoraisAnsys added a commit to ansys/pyaedt that referenced this issue Oct 27, 2023
@SMoraisAnsys
DOC: disable navigation_with_keys
bd02e25 
Problem
A warning is raised during workflow "Build project documentation".

Solution
Follow pydata/pydata-sphinx-theme#1492
instructions and disable "navigation_with_keys" as it is also something
that is defined as default for ansys sphinx theme (see
ansys/ansys-sphinx-theme#315)
SMoraisAnsys added a commit to ansys/pyprimemesh that referenced this issue Oct 27, 2023
@SMoraisAnsys
DOC: disable navigation_with_keys
3508dae 
Problem
A warning is raised during workflow "Build project documentation".

Solution
Follow pydata/pydata-sphinx-theme#1492
instructions and disable "navigation_with_keys" as it is also something
that is defined as default for ansys sphinx theme (see
ansys/ansys-sphinx-theme#315)
@DominicOram DominicOram mentioned this issue Oct 27, 2023
Open
carlosgjs pushed a commit to noisepy/NoisePy that referenced this issue Oct 27, 2023
@anujsinha3
refactor: change freq_norm from string to enum (#248)
b08fe9d 
* refactor: change freq_norm from string to enum

* refactor: pre-commit hook format changes

* refactor: change freq_norm from string to enum

* refactor: correct import

* refactor: add parameterized test cases

* refactor: fix import

* refactor: fix variable type

* refactor: fix data sphinx error

* refactor: revert the change

* refactor: change initialization of freq_norm from string to enum

* refactor: change initialization of freq_norm from string to enum

* refactor: change initialization of freq_norm from string to enum

* refactor: Fix navigation_with_keys warning.

Set navigation_with_keys to False to get rid of the warning. Setting it to True has negative accessibility implications: pydata/pydata-sphinx-theme#1492

* refactor: Fix navigation_with_keys warning.

Set navigation_with_keys to True

* refactor: revert change

* refactor: set navigation_with_keys as false to prevent sphinx validation error

* refactor: style consistency with \n
@lagru lagru mentioned this issue Oct 27, 2023
Merged
@carlosgjs carlosgjs mentioned this issue Oct 27, 2023
Merged
carlosgjs added a commit to noisepy/NoisePy that referenced this issue Oct 27, 2023
@carlosgjs @anujsinha3
refactor: change freq_norm from string to enum (#248) (#253)
cd5fc42 
* refactor: change freq_norm from string to enum

* refactor: pre-commit hook format changes

* refactor: change freq_norm from string to enum

* refactor: correct import

* refactor: add parameterized test cases

* refactor: fix import

* refactor: fix variable type

* refactor: fix data sphinx error

* refactor: revert the change

* refactor: change initialization of freq_norm from string to enum

* refactor: change initialization of freq_norm from string to enum

* refactor: change initialization of freq_norm from string to enum

* refactor: Fix navigation_with_keys warning.

Set navigation_with_keys to False to get rid of the warning. Setting it to True has negative accessibility implications: pydata/pydata-sphinx-theme#1492

* refactor: Fix navigation_with_keys warning.

Set navigation_with_keys to True

* refactor: revert change

* refactor: set navigation_with_keys as false to prevent sphinx validation error

* refactor: style consistency with \n

Co-authored-by: anujsinha3 <sinha.anuj30@gmail.com>
@carlosgjs carlosgjs mentioned this issue Oct 27, 2023
Merged
sphuber added a commit to aiidateam/aiida-quantumespresso that referenced this issue Oct 28, 2023
@sphuber
Docs: Address warning from pydata-sphinx-theme
c868431 
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.
sphuber added a commit to aiidateam/aiida-quantumespresso that referenced this issue Oct 28, 2023
@sphuber
Docs: Address warning from pydata-sphinx-theme (#978)
74bbaa2 
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.
feanil added a commit to openedx/docs.openedx.org that referenced this issue Oct 30, 2023
@feanil
feat: Disable navigating with keys.
356635c 
Although I think this is super convenient, it turns out that it is not
generally accessible.

See pydata/pydata-sphinx-theme#1492

`False` will be the default in the future but we explicitly set it now
to quiet a warning about the change.
feanil added a commit to openedx/edx-documentation that referenced this issue Oct 30, 2023
@feanil
feat: Disable navigating with keys.
3edd76c 
Although I think this is super convenient, it turns out that it is not
generally accessible.

See pydata/pydata-sphinx-theme#1492

`False` will be the default in the future but we explicitly set it now
to quiet a warning about the change.
feanil added a commit to openedx/edx-documentation that referenced this issue Oct 30, 2023
@feanil
feat: Disable navigating with keys.
181fca9 
Although I think this is super convenient, it turns out that it is not
generally accessible.

See pydata/pydata-sphinx-theme#1492

`False` will be the default in the future but we explicitly set it now
to quiet a warning about the change.
davidbtadokoro added a commit to davidbtadokoro/kworkflow that referenced this issue Oct 30, 2023
@davidbtadokoro
documentation: conf: Fix deprecated navigation_with_keys setting bug
754f01b 
[What]

At the current moment, by running the command

`./setup.sh --docs`

we are met with the current error:

  Warning, treated as error:
  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

By accessing the link mentioned in the error message, it seems that the
python-sphinx setting `navigation_with_keys` is, by default, set to
`True` and this creates accessibility problems. Thus, the site
compilation fails with the objective of warning users to make a
conscious decision about the setting.

[Why]

Reading the thread from the link, it seems that it is better to set
`navigation_with_keys` to `False`, as the kworkflow site doesn't look to
take advantage of the setting, and we need to make a decision about it.

[How]

Change the `navigation_with_keys` setting to `False` in the
`html_theme_options` Python dictionary of the `documentation/conf.py`
file, as indicated by the error message.

Signed-off-by: David Tadokoro <davidbtadokoro@usp.br>
@davidbtadokoro davidbtadokoro mentioned this issue Oct 30, 2023
Closed
rodrigosiqueira pushed a commit to kworkflow/kworkflow that referenced this issue Oct 31, 2023
@davidbtadokoro @rodrigosiqueira
documentation: conf: Fix deprecated navigation_with_keys setting bug
c70da76 
[What]

At the current moment, by running the command

`./setup.sh --docs`

we are met with the current error:

  Warning, treated as error:
  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

By accessing the link mentioned in the error message, it seems that the
python-sphinx setting `navigation_with_keys` is, by default, set to
`True` and this creates accessibility problems. Thus, the site
compilation fails with the objective of warning users to make a
conscious decision about the setting.

[Why]

Reading the thread from the link, it seems that it is better to set
`navigation_with_keys` to `False`, as the kworkflow site doesn't look to
take advantage of the setting, and we need to make a decision about it.

[How]

Change the `navigation_with_keys` setting to `False` in the
`html_theme_options` Python dictionary of the `documentation/conf.py`
file, as indicated by the error message.

Reviewed-by: Rodrigo Siqueira <siqueirajordao@riseup.net>
Signed-off-by: David Tadokoro <davidbtadokoro@usp.br>
JGBSouza pushed a commit to JGBSouza/kworkflow that referenced this issue Nov 1, 2023
@davidbtadokoro @JGBSouza
documentation: conf: Fix deprecated navigation_with_keys setting bug
ec4d334 
[What]

At the current moment, by running the command

`./setup.sh --docs`

we are met with the current error:

  Warning, treated as error:
  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

By accessing the link mentioned in the error message, it seems that the
python-sphinx setting `navigation_with_keys` is, by default, set to
`True` and this creates accessibility problems. Thus, the site
compilation fails with the objective of warning users to make a
conscious decision about the setting.

[Why]

Reading the thread from the link, it seems that it is better to set
`navigation_with_keys` to `False`, as the kworkflow site doesn't look to
take advantage of the setting, and we need to make a decision about it.

[How]

Change the `navigation_with_keys` setting to `False` in the
`html_theme_options` Python dictionary of the `documentation/conf.py`
file, as indicated by the error message.

Reviewed-by: Rodrigo Siqueira <siqueirajordao@riseup.net>
Signed-off-by: David Tadokoro <davidbtadokoro@usp.br>
SMoraisAnsys added a commit to ansys/pyaedt that referenced this issue Nov 4, 2023
@SMoraisAnsys
DOC: disable navigation_with_keys
047d2a8 
Problem
A warning is raised during workflow "Build project documentation".

Solution
Follow pydata/pydata-sphinx-theme#1492
instructions and disable "navigation_with_keys" as it is also something
that is defined as default for ansys sphinx theme (see
ansys/ansys-sphinx-theme#315)
@donerancl donerancl mentioned this issue Feb 2, 2024
Merged
clara-escanuela pushed a commit to clara-escanuela/ctapipe that referenced this issue Feb 15, 2024
@aknierim @clara-escanuela
Fix navigation_with_keys warning
5c7159d 
Set navigation_with_keys to False to get rid of the
warning. Setting it to True has negative accessibility
implications: pydata/pydata-sphinx-theme#1492
@bjlittle bjlittle mentioned this issue Feb 15, 2024
Merged
@scottyhq scottyhq mentioned this issue Feb 21, 2024
Open
Tobychev pushed a commit to Tobychev/ctapipe that referenced this issue Apr 11, 2024
@aknierim @Tobychev
Fix navigation_with_keys warning
f3b2639 
Set navigation_with_keys to False to get rid of the
warning. Setting it to True has negative accessibility
implications: pydata/pydata-sphinx-theme#1492
@mattpap mattpap mentioned this issue May 7, 2024
Merged
danibene added a commit to danibene/NeuroKit that referenced this issue May 19, 2024
@danibene
set "navigation_with_keys" to False to address failing doc check
ff44270 
pydata/pydata-sphinx-theme#1492

https://github.com/neuropsychology/NeuroKit/actions/runs/9148797107/job/25151722905?pr=991
@purva-thakre purva-thakre mentioned this issue Jun 10, 2024
Closed
swhmirror pushed a commit to SoftwareHeritage/swh-docs that referenced this issue Nov 26, 2024
@anlambert
sphinx/conf.py: Fix warning with latest pydata-sphinx-theme release
2c59f13 
Latest pydata-sphinx-theme release prints a new warning about
an accessibility issue and recommends to set to False the
navigation_with_keys theme option.

It fixes CI jobs on Jenkins as sphinx warnings are treated as
errors.

See pydata/pydata-sphinx-theme#1492
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

navigation_with_keys = False gabalafou/pydata-sphinx-theme
2 participants
@gabalafou @12rambau