Build doc as part of the CI workflow

google · Sep 5, 2023 · cc23de0 · cc23de0
1 parent 5bf8d3d
commit cc23de0
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -43,3 +43,29 @@ jobs:
           python -c "import jaxlib; print('jaxlib', jaxlib.__version__)"
           pytest tests
         shell: bash
+
+
+  build-and-test-docs:
+    name: "Build documentation"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Cancel previous
+        uses: styfle/cancel-workflow-action@0.11.0
+        with:
+          access_token: ${{ github.token }}
+        if: ${{github.ref != 'refs/heads/main'}}
+      - uses: "actions/checkout@v3"
+      - name: Set up Python 3.11
+        uses: "actions/setup-python@v4"
+        with:
+            python-version: 3.11
+      - name: Install dependencies
+        run: |
+          set -xe
+          pip install --upgrade pip setuptools wheel
+          pip install -r docs/requirements.txt
+      - name: Build documentation
+        run: |
+          set -xe
+          python -VV
+          cd docs && make clean && make html
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -14,3 +14,4 @@ tensorflow-datasets
 dm-haiku
 flax
 jupytext
+scikit-learn