Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
drammock authored Oct 12, 2023
1 parent f6624f6 commit cbf5d03
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions src/pydata_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,12 @@ def update_config(app):
)

# TODO: in 0.15, set the default navigation_with_keys value to False and remove this deprecation notice
if (
hasattr(theme_options, "navigation_with_keys")
and theme_options["navigation_with_keys"] is None
):
if theme_options.get("navigation_with_keys", None) is None:
logger.warning(
"The default value for `navigation_with_keys` will change to `False` in the next minor release."
"If you wish to guard the old behavior for your site, set `navigation_with_keys` to `True` in your `theme.conf` file."
"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"
)
Expand Down

0 comments on commit cbf5d03

Please sign in to comment.