Build docs in CI (fixes #497) (#498)

christiansandberg · Jul 9, 2024 · c4560da · c4560da
1 parent 6bd39ba
commit c4560da
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/.github/workflows/pythonpackage.yml b/.github/workflows/pythonpackage.yml
@@ -37,3 +37,19 @@ jobs:
       uses: codecov/codecov-action@v4
       with:
         token: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12
+        cache: 'pip'
+        cache-dependency-path: |
+          'pyproject.toml'
+          'doc/requirements.txt'
+    - name: Install dependencies
+      run: python3 -m pip install -r doc/requirements.txt -e .
+    - name: Build docs
+      run: make -C doc html
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,3 +1,3 @@
-sphinx
-sphinx-autodoc-typehints
-furo
+sphinx~=7.3
+sphinx-autodoc-typehints~=2.2
+furo~=2024.5