From 6ca7db365cdeae628e52e4df6e141efe9684cf84 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Fri, 23 Jan 2026 04:25:36 -0600 Subject: [PATCH 1/4] Fix Read the Docs build failures Read the Docs builds are throwing the following error: > Config validation error in `build.os`. Value `build` not found. This commit attempts to address all of the anticipated failures. --- .readthedocs.yml | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 0757b52..9da4ebc 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -6,11 +6,20 @@ version: 2 # Only compile HTML formats: [] +build: + os: 'ubuntu-24.04' + tools: + python: '3.13' + python: - version: 3.8 install: - requirements: docs/requirements_for_rtd.txt - method: pip path: . - #extra_requirements: - # - docs + extra_requirements: + - 'bz' + +sphinx: + configuration: 'docs/source/conf.py' + builder: 'html' + fail_on_warning: false From bd769613806a7cc3370f3ff91ee0202b372eff92 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Fri, 23 Jan 2026 04:27:17 -0600 Subject: [PATCH 2/4] Fix the Sphinx warning "Invalid configuration value" This is the full text of the Sphinx warning: ``` WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English). ``` --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 0a608bf..5903800 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -67,7 +67,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = 'en' # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: From bce4eeffd455194b2d2b0e650f039d0bc0f603f0 Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Fri, 23 Jan 2026 04:28:09 -0600 Subject: [PATCH 3/4] Fix a Sphinx config value info message The full text of the Sphinx info message is: ``` Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`. ``` --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 5903800..8436b84 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -33,7 +33,7 @@ templates_path = ['_templates'] # The suffix of source filenames. -source_suffix = '.rst' +source_suffix = {'.rst': 'restructuredtext'} # The encoding of source files. # source_encoding = 'utf-8-sig' From 1ed2d398a391809d4c7db0a14ccb3977ebbf71bb Mon Sep 17 00:00:00 2001 From: Kurt McKee Date: Fri, 23 Jan 2026 04:29:23 -0600 Subject: [PATCH 4/4] Fix docs build warnings found when `nitpicky` mode is enabled Two warnings were thrown for the same underlying issue: ``` WARNING: py:exc reference target not found: seekpath.SupercellWarning [ref.exc] ``` --- docs/source/module_guide/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/module_guide/index.rst b/docs/source/module_guide/index.rst index b179216..01ab808 100644 --- a/docs/source/module_guide/index.rst +++ b/docs/source/module_guide/index.rst @@ -20,3 +20,9 @@ The HPKOT module .. automodule:: seekpath.hpkot.tools :members: + + +Warnings +-------- + +.. autoclass:: seekpath.SupercellWarning