From 1cf38eb5d71b50f3b3130f2d8c4e3f672adb6681 Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Mon, 4 May 2026 01:12:06 -0400 Subject: [PATCH 1/3] chore: use native readthedocs uv integration Signed-off-by: Henry Schreiner --- docs/pages/guides/docs.md | 26 ++++++++++++------- .../.readthedocs.yaml | 26 +++++++++++++++---- 2 files changed, 38 insertions(+), 14 deletions(-) diff --git a/docs/pages/guides/docs.md b/docs/pages/guides/docs.md index b92bba78..aff1ca0e 100644 --- a/docs/pages/guides/docs.md +++ b/docs/pages/guides/docs.md @@ -499,17 +499,22 @@ with code_fence("yaml"): version: 2 + + build: os: ubuntu-24.04 tools: - python: "3.13" - commands: - - asdf plugin add uv - - asdf install uv latest - - asdf global uv latest - - uv sync --group docs - - uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en - docs $READTHEDOCS_OUTPUT/html + python: "3.14" + +sphinx: + configuration: docs/conf.py + +python: + install: + - method: uv + command: sync + groups: + - docs ``` @@ -527,10 +532,13 @@ with code_fence("yaml"): version: 2 + + build: os: ubuntu-24.04 tools: - python: "3.13" + python: "3.14" + commands: - asdf plugin add uv - asdf install uv latest diff --git a/{{cookiecutter.project_name}}/.readthedocs.yaml b/{{cookiecutter.project_name}}/.readthedocs.yaml index 94df0435..332f5ec6 100644 --- a/{{cookiecutter.project_name}}/.readthedocs.yaml +++ b/{{cookiecutter.project_name}}/.readthedocs.yaml @@ -3,22 +3,38 @@ version: 2 + + build: os: ubuntu-24.04 tools: - python: "3.13" + python: "3.14" + +{%- if cookiecutter.docs == 'sphinx' %} + +sphinx: + configuration: docs/conf.py + +python: + install: + - method: uv + command: sync + groups: + - docs + +{%- else %} + commands: - asdf plugin add uv - asdf install uv latest - asdf global uv latest - uv sync --group docs - {%- if cookiecutter.docs == 'sphinx' %} - - uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en - docs $READTHEDOCS_OUTPUT/html - {%- elif cookiecutter.docs == 'mkdocs' %} + {%- if cookiecutter.docs == 'mkdocs' %} - uv run mkdocs build --site-dir $READTHEDOCS_OUTPUT/html {%- elif cookiecutter.docs == 'zensical' %} - uv run zensical build - mkdir -p $READTHEDOCS_OUTPUT/html/ - cp --recursive site/* $READTHEDOCS_OUTPUT/html/ {%- endif %} + +{%- endif %} From b7d99fa4d7a3dbf6391819254f6ab1e5730d9fbb Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Mon, 4 May 2026 08:50:57 -0400 Subject: [PATCH 2/3] Update {{cookiecutter.project_name}}/.readthedocs.yaml --- {{cookiecutter.project_name}}/.readthedocs.yaml | 2 -- 1 file changed, 2 deletions(-) diff --git a/{{cookiecutter.project_name}}/.readthedocs.yaml b/{{cookiecutter.project_name}}/.readthedocs.yaml index 332f5ec6..f3bf0e9e 100644 --- a/{{cookiecutter.project_name}}/.readthedocs.yaml +++ b/{{cookiecutter.project_name}}/.readthedocs.yaml @@ -3,8 +3,6 @@ version: 2 - - build: os: ubuntu-24.04 tools: From 9dcc852586ff833385e777ded4cb1072575bb327 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Mon, 4 May 2026 12:51:50 +0000 Subject: [PATCH 3/3] style: pre-commit fixes --- docs/pages/guides/docs.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/pages/guides/docs.md b/docs/pages/guides/docs.md index aff1ca0e..bceb5281 100644 --- a/docs/pages/guides/docs.md +++ b/docs/pages/guides/docs.md @@ -499,8 +499,6 @@ with code_fence("yaml"): version: 2 - - build: os: ubuntu-24.04 tools: @@ -532,8 +530,6 @@ with code_fence("yaml"): version: 2 - - build: os: ubuntu-24.04 tools: