Skip to content

Commit 8b3affc

Browse files
committed
chore: use native readthedocs uv integration
Signed-off-by: Henry Schreiner <henryfs@princeton.edu>
1 parent 3e7d808 commit 8b3affc

2 files changed

Lines changed: 38 additions & 14 deletions

File tree

docs/pages/guides/docs.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -499,17 +499,22 @@ with code_fence("yaml"):
499499
500500
version: 2
501501
502+
503+
502504
build:
503505
os: ubuntu-24.04
504506
tools:
505-
python: "3.13"
506-
commands:
507-
- asdf plugin add uv
508-
- asdf install uv latest
509-
- asdf global uv latest
510-
- uv sync --group docs
511-
- uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en
512-
docs $READTHEDOCS_OUTPUT/html
507+
python: "3.14"
508+
509+
sphinx:
510+
configuration: docs/conf.py
511+
512+
python:
513+
install:
514+
- method: uv
515+
command: sync
516+
groups:
517+
- docs
513518
```
514519
<!-- prettier-ignore-end -->
515520
<!-- [[[end]]] -->
@@ -527,10 +532,13 @@ with code_fence("yaml"):
527532
528533
version: 2
529534
535+
536+
530537
build:
531538
os: ubuntu-24.04
532539
tools:
533-
python: "3.13"
540+
python: "3.14"
541+
534542
commands:
535543
- asdf plugin add uv
536544
- asdf install uv latest

{{cookiecutter.project_name}}/.readthedocs.yaml

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,38 @@
33

44
version: 2
55

6+
7+
68
build:
79
os: ubuntu-24.04
810
tools:
9-
python: "3.13"
11+
python: "3.14"
12+
13+
{%- if cookiecutter.docs == 'sphinx' %}
14+
15+
sphinx:
16+
configuration: docs/conf.py
17+
18+
python:
19+
install:
20+
- method: uv
21+
command: sync
22+
groups:
23+
- docs
24+
25+
{%- else %}
26+
1027
commands:
1128
- asdf plugin add uv
1229
- asdf install uv latest
1330
- asdf global uv latest
1431
- uv sync --group docs
15-
{%- if cookiecutter.docs == 'sphinx' %}
16-
- uv run python -m sphinx -T -b html -d docs/_build/doctrees -D language=en
17-
docs $READTHEDOCS_OUTPUT/html
18-
{%- elif cookiecutter.docs == 'mkdocs' %}
32+
{%- if cookiecutter.docs == 'mkdocs' %}
1933
- uv run mkdocs build --site-dir $READTHEDOCS_OUTPUT/html
2034
{%- elif cookiecutter.docs == 'zensical' %}
2135
- uv run zensical build
2236
- mkdir -p $READTHEDOCS_OUTPUT/html/
2337
- cp --recursive site/* $READTHEDOCS_OUTPUT/html/
2438
{%- endif %}
39+
40+
{%- endif %}

0 commit comments

Comments
 (0)