Merge pull request #424 from neutrinoceros/dep/pep735_docs

DEP: move docs requirements to a PEP 735 dependency group
neutrinoceros · Jan 1, 2025 · 5b148c3 · 5b148c3
2 parents 478ef56 + a51c147
commit 5b148c3
Show file tree

Hide file tree

Showing 6 changed files with 644 additions and 135 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -111,12 +111,9 @@ jobs:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
     - uses: astral-sh/setup-uv@887a942a15af3a7626099df99e897a18d9e5ab3a # v5.1.0
     - name: Setup env
-      run: |
-        uv venv
-        uv pip install -r docs/requirements.txt
+      run: uv sync --frozen --group docs
     - name: Build
-      run: |
-        uv run mkdocs build
+      run: uv run mkdocs build
     - name: Upload artifacts
       uses: actions/upload-artifact@6f51ac03b9356f520e9adb1b1b7802705f340c2b # v4.5.0
       with:

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,11 +10,12 @@ build:
   os: ubuntu-22.04
   tools:
     python: '3'
+  commands:
+  - asdf plugin add uv
+  - asdf install uv latest
+  - asdf global uv latest
+  - uv sync --frozen --group docs
+  - uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
 
 mkdocs:
   configuration: mkdocs.yml
-
-# Optionally declare the Python requirements required to build your docs
-python:
-  install:
-  - requirements: docs/requirements.txt
diff --git a/docs/requirements.in b/docs/requirements.in
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,6 +50,12 @@ typecheck = [
     "mypy>=1.11.2",
     "pyright>=1.1.390",
 ]
+docs = [
+    "mkdocs>=1.5.3",
+    "mkdocs-include-markdown-plugin>=6.0.1",
+    "mkdocs-material>=9.4.2",
+    "mkdocstrings[python]>=0.23.0",
+]
 
 [tool.hatch.build.targets.sdist]
 exclude = [