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

CI failure: linux docs - due to warning emitted by sphinx template #15309

Closed
fcollonval opened this issue Oct 26, 2023 · 1 comment · Fixed by #15302 or #15310
Closed

CI failure: linux docs - due to warning emitted by sphinx template #15309

fcollonval opened this issue Oct 26, 2023 · 1 comment · Fixed by #15302 or #15310
Labels
maintenance status:Needs Triage Applied to new issues that need triage
Milestone
4.0.x

Comments

@fcollonval
Copy link
Member

Description

Our CI generating the doc considers warning as error. An upstream change to the pydata sphinx template emits a warning that breaks the CI.

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
@fcollonval fcollonval added bug status:Needs Triage Applied to new issues that need triage maintenance and removed bug labels Oct 26, 2023
@fcollonval fcollonval added this to the 4.0.x milestone Oct 26, 2023
This was referenced Oct 26, 2023
Closed
Merged
@fcollonval fcollonval mentioned this issue Oct 26, 2023
Merged
@krassowski
Copy link
Member

Thanks for the issue! #15302/#15304 should solve it.

@fcollonval fcollonval linked a pull request Oct 26, 2023 that will close this issue
Turn off navigation with keys #15310
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
maintenance status:Needs Triage Applied to new issues that need triage
Projects
None yet
Milestone
4.0.x
2 participants
@krassowski @fcollonval