Skip to content

chore: use native readthedocs uv integration #783

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henryiii merged 3 commits into from
May 4, 2026
+32 −14
Merged

chore: use native readthedocs uv integration #783

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1cf38eb
chore: use native readthedocs uv integration
henryiii May 4, 2026
b7d99fa
Update {{cookiecutter.project_name}}/.readthedocs.yaml
henryiii May 4, 2026
9dcc852
style: pre-commit fixes
pre-commit-ci[bot] May 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 13 additions & 9 deletions docs/pages/guides/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -502,14 +502,17 @@ 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
```
<!-- prettier-ignore-end -->
<!-- [[[end]]] -->
Expand All @@ -530,7 +533,8 @@ version: 2
build:
os: ubuntu-24.04
tools:
python: "3.13"
python: "3.14"

commands:
- asdf plugin add uv
- asdf install uv latest
Expand Down
24 changes: 19 additions & 5 deletions {{cookiecutter.project_name}}/.readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,33 @@ 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 %}
Loading