From 3dc25cfd9441b49ad86de1e553a172962e609ddb Mon Sep 17 00:00:00 2001 From: David Turner Date: Wed, 7 Jan 2026 13:49:03 -0500 Subject: [PATCH 1/4] Update Read the Docs configuration for Sphinx build The error is coming from Read the Docs now requiring a build.os (and build.tools.python) section in v2 configs. Add a build: block (and fix the indentation under python.install) and the config should validate. --- .readthedocs.yml | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index b925ccb1..55091a7c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,21 +1,19 @@ -# .readthedocs.yml -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required version: 2 -# Build documentation in the docs/ directory with Sphinx +build: + os: ubuntu-22.04 + tools: + python: "3.11" + sphinx: configuration: docs/sphinx/source/conf.py -# Just generate htmlzip version, as pdf failing due to inclusion of svg files (in badges) formats: - htmlzip python: install: - - requirements: docs/sphinx/requirements.txt + - requirements: docs/sphinx/requirements.txt submodules: exclude: all From fc5cd4c98c47fe8a52f9aace24c6ae36322ce99a Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 8 Jan 2026 13:50:04 -0500 Subject: [PATCH 2/4] Fix package install for docs --- .readthedocs.yml | 8 ++++---- docs/sphinx/requirements.txt | 2 -- 2 files changed, 4 insertions(+), 6 deletions(-) delete mode 100644 docs/sphinx/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 55091a7c..21d3f7f5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,15 +5,15 @@ build: tools: python: "3.11" + commands: + - python -m pip install -U pip + - python -m pip install . --group docs + sphinx: configuration: docs/sphinx/source/conf.py formats: - htmlzip -python: - install: - - requirements: docs/sphinx/requirements.txt - submodules: exclude: all diff --git a/docs/sphinx/requirements.txt b/docs/sphinx/requirements.txt deleted file mode 100644 index 759ed661..00000000 --- a/docs/sphinx/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -# Install all the dependencies ---group=docs From 6f31bac1fcc2762f12b0975fe615a39e2b57df99 Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 8 Jan 2026 13:58:38 -0500 Subject: [PATCH 3/4] Move to uv for readthedocs --- .readthedocs.yml | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 21d3f7f5..bdb9f414 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,16 +1,21 @@ version: 2 -build: - os: ubuntu-22.04 - tools: - python: "3.11" - - commands: - - python -m pip install -U pip - - python -m pip install . --group docs - sphinx: - configuration: docs/sphinx/source/conf.py + configuration: docs/sphinx/source/conf.py + +build: + os: ubuntu-24.04 + tools: + python: "3.13" + jobs: + pre_create_environment: + - asdf plugin add uv + - asdf install uv latest + - asdf global uv latest + create_environment: + - uv venv "${READTHEDOCS_VIRTUALENV_PATH}" + install: + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs formats: - htmlzip From 13d714ab38ec86f1617f43eb35be0c4f54187882 Mon Sep 17 00:00:00 2001 From: David Turner Date: Thu, 8 Jan 2026 14:00:18 -0500 Subject: [PATCH 4/4] Update Read the Docs configuration to remove frozen option from uv sync --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index bdb9f414..c3c1c0d7 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -15,7 +15,7 @@ build: create_environment: - uv venv "${READTHEDOCS_VIRTUALENV_PATH}" install: - - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --group docs formats: - htmlzip