Migrate docs build to use uv (#5438)

Following the official docs: https://docs.readthedocs.io/en/latest/build-customization.html#install-dependencies-with-uv
cookiecutter · Oct 7, 2024 · 2d06ddd · 2d06ddd
1 parent 3252aa7
commit 2d06ddd
Show file tree

Hide file tree

Showing 4 changed files with 346 additions and 9 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,12 +9,14 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
+  commands:
+    - asdf plugin add uv
+    - asdf install uv latest
+    - asdf global uv latest
+    - uv venv
+    - uv pip install .[docs]
+    - .venv/bin/python -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/conf.py
-
-# Declare the Python requirements required to build your docs
-python:
-  install:
-    - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,12 @@ dependencies = [
   "tox==4.21.2",
   "tox-uv>=1.11.2",
 ]
+optional-dependencies.docs = [
+  "myst-parser>=4",
+  "sphinx>=8.0.2",
+  "sphinx-autobuild>=2024.10.3",
+  "sphinx-rtd-theme>=3",
+]
 urls = { Repository = "https://github.com/cookiecutter/cookiecutter-django" }
 
 [tool.black]