Merge pull request #146 from stanford-centaur/build/doc

doc: Fix documentation build pipeline

Author: lenianiva

.github/workflows/docs.yaml .github/workflows/doc.yaml.github/workflows/docs.yaml renamed to .github/workflows/doc.yaml

@@ -1,4 +1,4 @@
-name: deploy-docs
+name: deploy-doc
 
 on:
   push:
@@ -40,7 +40,7 @@ jobs:
 
     - name: Build documentations
       run: |
-        uvx --with notebook jupyter-book build doc
+        uv run --group dev jupyter-book build doc
 
     # Upload the book's HTML as an artifact
     - name: Upload artifact

README.md

@@ -32,12 +32,11 @@ uv build
 
 Build the documentations by
 ```sh
-uvx --with notebook jupyter-book build doc
+uv run --group dev jupyter-book build doc
 ```
 Then serve
 ```sh
-cd doc/_build/html
-python3 -m http.server -d .
+python3 -m http.server -d doc/_build/html
 ```
 
 ### Examples

pyproject.toml

@@ -12,6 +12,7 @@ requires-python = ">=3.11.0"
 dependencies = []
 [dependency-groups]
 dev = [
+    "jupyter-book>=1.0.4.post1",
     "notebook",
     "pytest>=8.4.1",
 ]