-
-
Notifications
You must be signed in to change notification settings - Fork 12
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
27 lines (23 loc) · 938 Bytes
/
.readthedocs.yaml
File metadata and controls
27 lines (23 loc) · 938 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html
version: 2
build:
os: ubuntu-24.04
tools:
python: "3.13"
commands:
# Install uv and sync dependencies from uv.lock
- pip install uv
# Important: this fetch style preserves tag reachability for hatch-vcs.
- git fetch origin --depth 100
- uv sync --frozen --no-dev --group docs
- uv run sphinx-build -b html docs $READTHEDOCS_OUTPUT/html
# Build documentation from the docs/ directory using Sphinx
sphinx:
configuration: docs/conf.py
# Notes:
# - We rely on uv.lock for reproducible dependency resolution.
# - The old-style `python.install` block using requirements.txt is no longer viable
# as we don't have that file checked in anymore.
# - Use `uv export --locked --format=requirements-txt` to generate such a file
# if a pip-compatible file is ever required, e.g. for environments without uv.