Only update docs on release

danielward27 · Aug 14, 2023 · dc7ffc6 · dc7ffc6
1 parent bbaf4b7
commit dc7ffc6
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 38 deletions.
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -35,4 +35,37 @@ jobs:
         uses: pypa/gh-action-pypi-publish@master
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}
+
+  docs:
+    name: Build and publish documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
 
+      - name: Install pandoc
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -r docs/requirements.txt
+      - name: Test documentation
+        run: |
+          make -C docs doctest
+      - name: Sphinx build
+        run: |
+          sphinx-build docs docs/_build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/
+          force_orphan: true
+