Skip to content

Commit b59ef79

Browse files
authored
fix: docs deployment failures due to missing config (#53)
This fixes the docs being unable to get published to readthedocs due to a missing `.readthedocs.yaml` as it is now a required file.
1 parent f19a091 commit b59ef79

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

.readthedocs.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Read the Docs configuration file for Sphinx projects
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
build:
6+
os: ubuntu-24.04
7+
tools:
8+
python: "3.14"
9+
jobs:
10+
# Based on https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv
11+
pre_create_environment:
12+
- asdf plugin add uv
13+
- asdf install uv latest
14+
- asdf global uv latest
15+
create_environment:
16+
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
17+
install:
18+
- >-
19+
UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}"
20+
uv sync --frozen --group dev
21+
22+
sphinx:
23+
configuration: docs/conf.py
24+
# Fail on all warnings to avoid broken references
25+
fail_on_warning: true

VERSION.txt

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)