Adds Github Actions workflow to deploy Github Pages

Author: SarcasticMatrix

.github/workflows/gh-pages.yml

@@ -1,27 +1,35 @@
-name: documentation
+name: "Build and deploy Github pages"
 
-on: push
-
-permissions:
-  contents: write
+on:
+  push:
+    branches:
+      - main
 
 jobs:
-  docs:
+  deploy:
     runs-on: ubuntu-latest
+
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10'
+
       - name: Install dependencies
         run: |
-          pip install sphinx sphinx_rtd_theme myst_parser
-      - name: Sphinx build
+          python -m pip install --upgrade pip
+          pip install sphinx
+
+      - name: Build Sphinx documentation
         run: |
-          sphinx-build doc _build
+          cd doc
+          make html
+
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        uses: peaceiris/actions-gh-pages@v4
         with:
-          publish_branch: gh-pages
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: _build/
-          force_orphan: true
+          publish_dir: doc/_build/html