Build docs within uv for full access to python classes and methods

Also fix an issue with mermaid + sphinx: mermaid-js/mermaid#5954
jumpstarter-dev · Oct 11, 2024 · 0f14697 · 0f14697
1 parent ee6a9bf
commit 0f14697
Show file tree

Hide file tree

Showing 3 changed files with 334 additions and 238 deletions.
diff --git a/Makefile b/Makefile
@@ -3,8 +3,8 @@ EXAMPLE_TARGETS = $(subst examples/,example-,$(wildcard examples/*))
 
 default: build
 
-docs:
-	cd docs && make html
+docs: sync
+	cd docs && uv run make html
 
 watch-docs:
 	sphinx-autobuild docs/source docs/build/html

diff --git a/pyproject.toml b/pyproject.toml
@@ -28,7 +28,7 @@ dependencies = [
 
 [project.optional-dependencies]
 docs = [
-    "sphinx>=8.0.2",
+    "sphinx<8.1.0",
     "myst-parser>=4.0.0",
     "sphinxcontrib-mermaid>=0.9.2",
     "furo>=2024.8.6",