-
-
Notifications
You must be signed in to change notification settings - Fork 15
/
Copy path.readthedocs.yml
28 lines (24 loc) · 1.03 KB
/
.readthedocs.yml
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
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
sphinx:
# Path to your Sphinx configuration file, required as of
# https://about.readthedocs.com/blog/2024/12/deprecate-config-files-without-sphinx-or-mkdocs-config/
configuration: docs/source/conf.py
# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
apt_packages:
- graphviz
tools:
python: "3.12"
# adapted from uv recipe at https://docs.readthedocs.io/en/stable/build-customization.html#install-dependencies-with-uv
# and comment at https://github.com/readthedocs/readthedocs.org/issues/11289#issuecomment-2103832834
commands:
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- uv venv $READTHEDOCS_VIRTUALENV_PATH
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH UV_PREVIEW=1 uv pip install .[docs]
- python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html