pydata-sphinx-theme: Warning triggered for navigation_with_keys
In many of the jupyter repos, we use pydata_sphinx_theme. All of our docs builds have started failing with 0.14.2 with the warning about default value of navigation_with_keys changing. Would it be possible to not trigger that warning? This seems like a lot of additional work for such a benign change. If this is going to be the policy of pydata_sphinx_theme in general, I’d like to know that as well so I can switch themes across the board.
https://github.com/jupyter/notebook/actions/runs/6634029880/job/18038165438
About this issue
- Original URL
- State: closed
- Created 8 months ago
- Comments: 18
Commits related to this issue
- Temporarily avoid the current build of pydata-sphinx-theme (#14332) There appears to be a bug in the latest release of pydata-sphinx theme where a warning that was intended to be thrown conditionally... — committed to rapidsai/cudf by vyasr 8 months ago
- Temporarily avoid pydata-sphinx-theme version 0.14.2. See https://github.com/pydata/pydata-sphinx-theme/issues/1539 for additional context. — committed to csadorf/cuml by csadorf 8 months ago
- Pin theme (#1289) See https://github.com/pydata/pydata-sphinx-theme/issues/1539 and https://github.com/rapidsai/cudf/pull/14332 for additional context. Authors: - Vyas Ramasubramani (https://githu... — committed to rapidsai/cuspatial by vyasr 8 months ago
- Temporarily avoid pydata-sphinx-theme version 0.14.2. (#5629) See https://github.com/pydata/pydata-sphinx-theme/issues/1539 for additional context. Authors: - Simon Adorf (https://github.com/csado... — committed to rapidsai/cuml by csadorf 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-data-api by MichaelRoytman 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-dashboard by MichaelRoytman 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-data-api by MichaelRoytman 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-data-api by MichaelRoytman 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-data-api by MichaelRoytman 8 months ago
- fix: set navigation_with_keys value False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default was removed and a warning was added that woul... — committed to openedx/edx-analytics-data-api by MichaelRoytman 8 months ago
I’m not sure that I understand the nature of this issue perfectly, but I’ll just note that I think it’s not a good idea to raise Sphinx warnings just as a way of giving the user notifications (at least anything in a way that will fail with
-W). I know a lot of projects that tell Sphinx to “fail on warning” in order to catch regressions in their docs.