-
Notifications
You must be signed in to change notification settings - Fork 512
Expand file tree
/
Copy path.readthedocs.yaml
More file actions
36 lines (32 loc) · 981 Bytes
/
.readthedocs.yaml
File metadata and controls
36 lines (32 loc) · 981 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
28
29
30
31
32
33
34
35
36
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: dirhtml
configuration: docs/conf.py
fail_on_warning: true
# Optionally build your docs in additional formats such as PDF
# formats:
# - pdf
# - epub
build:
os: ubuntu-24.04
tools:
python: "3.12"
jobs:
post_checkout:
- git fetch --tags --unshallow # Also fetch tags
post_system_dependencies:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
create_environment:
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
install:
- make setup-docs UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}"
build:
html:
- make docs UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" DOCS_OUTPUT="$READTHEDOCS_OUTPUT/html/" GIT_DISCOVERY_ACROSS_FILESYSTEM=1