-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
26 lines (24 loc) · 895 Bytes
/
.readthedocs.yaml
File metadata and controls
26 lines (24 loc) · 895 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
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Set the version of Python and other tools you might need
build:
os: "ubuntu-22.04"
tools:
python: "3.12"
jobs:
post_create_environment:
# Install uv (https://docs.astral.sh/uv/)
- pip install uv
post_install:
# Install dependencies into the RTD virtualenv using uv
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv sync --extra dev
# Replace the 'mkdocs' key with a manual 'build' job
build:
html:
# Create the directory first to prevent errors
- mkdir -p $READTHEDOCS_OUTPUT/html/
# Build directly into the RTD output directory
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH uv run mkdocs build --config-file mkdocs.yml --site-dir $READTHEDOCS_OUTPUT/html/