Skip to content
This repository was archived by the owner on May 1, 2024. It is now read-only.

Commit f4e5823

Browse files
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. * pydata/pydata-sphinx-theme#1539 * pydata/pydata-sphinx-theme#987 (comment)
1 parent 243f8dc commit f4e5823

2 files changed

Lines changed: 14 additions & 2 deletions

File tree

.readthedocs.yaml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,17 @@
55
# Required: the version of this file's schema.
66
version: 2
77

8+
build:
9+
os: "ubuntu-20.04"
10+
tools:
11+
python: "3.8"
12+
813
# Build documentation in the docs/ directory with Sphinx
914
sphinx:
1015
configuration: docs/api/source/conf.py
1116

12-
# Optionally set the version of Python and requirements required to build your docs
17+
# We recommend specifying your dependencies to enable reproducible builds:
18+
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
1319
python:
14-
version: "3.8"
1520
install:
1621
- requirements: requirements/doc.txt

docs/api/source/conf.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@
6060
"use_repository_button": True,
6161
"use_issues_button": True,
6262
"use_edit_page_button": True,
63+
# False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default
64+
# was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the
65+
# "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set
66+
# this value. I have set it to the default value explicitly. Please see the following GitHub comments for context.
67+
# https://github.com/pydata/pydata-sphinx-theme/issues/1539
68+
# https://github.com/pydata/pydata-sphinx-theme/issues/987#issuecomment-1277214209
69+
"navigation_with_keys": False,
6370
# Please don't change unless you know what you're doing.
6471
"extra_footer": """
6572
<a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">

0 commit comments

Comments
 (0)