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 navigation with keys for docs HTML theme #5747

Merged
merged 1 commit into from Feb 15, 2024

Conversation

bjlittle
Copy link
Member

🚀 Pull Request

Description

This pull-request avoids the following diagnostic issued by pydata-sphinx-theme:

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

Reference:


Consult Iris pull request check list

@bjlittle bjlittle changed the title Disable navidation with keys for docs HTML theme options Disable navigation with keys for docs HTML theme Feb 15, 2024
Copy link

codecov bot commented Feb 15, 2024

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (a47fd34) 89.71% compared to head (69cbea7) 89.74%.
Report is 11 commits behind head on main.

Files Patch % Lines
lib/iris/_shapefiles.py 98.79% 0 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5747      +/-   ##
==========================================
+ Coverage   89.71%   89.74%   +0.03%     
==========================================
  Files          90       91       +1     
  Lines       22815    22906      +91     
  Branches     5438     5458      +20     
==========================================
+ Hits        20468    20558      +90     
  Misses       1617     1617              
- Partials      730      731       +1     

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

@tkknight tkknight merged commit f8a45be into SciTools:main Feb 15, 2024
16 of 17 checks passed
@bjlittle bjlittle deleted the docs-disable-navigation-with-keys branch February 16, 2024 09:41
tkknight added a commit to tkknight/iris that referenced this pull request Feb 20, 2024
…umpydoc-pre-commit

* 'numpydoc-pre-commit' of github.com:tkknight/iris:
  Update CF standard names to v84. (SciTools#5761)
  Regrid docs fix (SciTools#5758)
  Improve ncdata and CF information on "iris heart xarray" page (SciTools#5752)
  Pin ASV - airspeed-velocity/asv#1385. (SciTools#5756)
  Normalise units of coordinate bounds (SciTools#5746)
  Add "Which Regridder?" Documentation (SciTools#5742)
  Document `Coord.ignore_axis` (SciTools#5744)
  Disable navidation with keys for docs HTML theme options (SciTools#5747)
  Shapefile masking (SciTools#5470)
  [pre-commit.ci] pre-commit autoupdate (SciTools#5739)
  DOCS: Add whatsnew for ruff pydocstyle compliance (SciTools#5700)
  update docstring (SciTools#5737)
  Updated environment lockfiles (SciTools#5738)
  Consider NaNs equal when comparing cubes (SciTools#5713)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants