From 780624d173696aa56b5b7de49b30a324c79b04d0 Mon Sep 17 00:00:00 2001 From: michaelroytman Date: Fri, 27 Oct 2023 16:23:35 -0400 Subject: [PATCH] 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 would be emitted whenever navigation_with_keys was not set. Because of the "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set this value. I have set it to the default value explicitly. Please see the following GitHub comments for context. * https://github.com/pydata/pydata-sphinx-theme/issues/1539 * https://github.com/pydata/pydata-sphinx-theme/issues/987#issuecomment-1277214209 --- docs/api/source/conf.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/api/source/conf.py b/docs/api/source/conf.py index 79a5ea85..829cfd35 100644 --- a/docs/api/source/conf.py +++ b/docs/api/source/conf.py @@ -60,6 +60,13 @@ "use_repository_button": True, "use_issues_button": True, "use_edit_page_button": True, + # 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 would be emitted whenever navigation_with_keys was not set. Because of the + # "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set + # this value. I have set it to the default value explicitly. Please see the following GitHub comments for context. + # https://github.com/pydata/pydata-sphinx-theme/issues/1539 + # https://github.com/pydata/pydata-sphinx-theme/issues/987#issuecomment-1277214209 + "navigation_with_keys": False, # Please don't change unless you know what you're doing. "extra_footer": """