Skip to content

Commit 27aa136

Browse files
authored
use uv for docs build (#502)
1 parent 3949663 commit 27aa136

File tree

5 files changed

+406
-67
lines changed

5 files changed

+406
-67
lines changed

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permissions:
1212
contents: read
1313

1414
env:
15-
PREK_VERSION: '0.2.11'
15+
PREK_VERSION: '0.2.13'
1616

1717
jobs:
1818
prek:

.readthedocs.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,15 @@ build:
88
os: ubuntu-24.04
99
tools:
1010
python: "3.10"
11+
jobs:
12+
pre_create_environment:
13+
- asdf plugin add uv
14+
- asdf install uv latest:0.9
15+
- asdf global uv latest
16+
create_environment:
17+
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
18+
install:
19+
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --frozen --group docs
1120

1221
mkdocs:
1322
configuration: mkdocs.yml
@@ -16,7 +25,3 @@ mkdocs:
1625

1726
# Optionally build your docs in additional formats such as PDF and ePub
1827
formats: all
19-
20-
python:
21-
install:
22-
- requirements: docs/requirements.txt

docs/requirements.txt

Lines changed: 0 additions & 14 deletions
This file was deleted.

pyproject.toml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,27 @@ dev = [
5252
"boto3-stubs-lite[iam,s3,sts]>=1.40.0,<2.0.0",
5353
"coverage>=7.11.0,<8.0.0",
5454
"mypy>=1.18.0,<2.0.0",
55-
"prek>=0.2.11,<0.3.0",
55+
"prek>=0.2.13,<0.3.0",
5656
"pytest>=8.4.0,<9.0.0",
5757
"types-pyyaml>=6.0.12,<7.0.0",
5858
]
5959

60+
docs = [
61+
"atomicwrites>=1.4.0,<2.0.0",
62+
"distlib>=0.4.0,<0.5.0",
63+
"docutils>=0.22.0,<0.23.0",
64+
"filelock>=3.20.0,<4.0.0",
65+
"mkdocs>=1.6.0,<2.0.0",
66+
"mkdocs-material>=9.6.0,<10.0.0",
67+
"mkdocs-material-extensions>=1.3.0,<2.0.0",
68+
"mkdocstrings>=0.30.0,<0.31.0",
69+
"mkdocstrings-python>=1.18.0,<2.0.0",
70+
"mkdocstrings-python-legacy>=0.2.0,<0.3.0",
71+
"pygments>=2.19.0,<3.0.0",
72+
"pymdown-extensions>=10.16.0,<11.0.0",
73+
"pytkdocs>=0.16.0,<0.17.0",
74+
]
75+
6076
[build-system]
6177
requires = ["uv_build~=0.9.0"]
6278
build-backend = "uv_build"

0 commit comments

Comments
 (0)