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

Commit

Permalink
fix: set navigation_with_keys value
Browse files Browse the repository at this point in the history
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)
  • Loading branch information
MichaelRoytman committed Oct 30, 2023
1 parent 243f8dc commit f4e5823
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
9 changes: 7 additions & 2 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,17 @@
# Required: the version of this file's schema.
version: 2

build:
os: "ubuntu-20.04"
tools:
python: "3.8"

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/api/source/conf.py

# Optionally set the version of Python and requirements required to build your docs
# We recommend specifying your dependencies to enable reproducible builds:
# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
python:
version: "3.8"
install:
- requirements: requirements/doc.txt
7 changes: 7 additions & 0 deletions docs/api/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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": """
<a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">
Expand Down

0 comments on commit f4e5823

Please sign in to comment.