add sphinx workflow

.github/workflows/sphinx.yml

@@ -1,25 +1,26 @@
-name: documentation
+name: "Sphinx: Render docs"
+
+on: push
 
-on: [push, pull_request, workflow_dispatch]
-permissions:
- contents: write
 jobs:
- docs:
- runs-on: ubuntu-latest
- steps:
- - uses: actions/checkout@v3
- - uses: actions/setup-python@v3
- - name: Install dependencies
-   run: |
-       pip install sphinx sphinx_rtd_theme myst_parser
- - name: Sphinx build
-   run: |
-     sphinx-build doc _build
- - name: Deploy to GitHub Pages
-   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: _build/
-     force_orphan: true
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+      with:
+        pre-build-command: python -m pip install sphinx_rtd_theme
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v4
+      with:
+        name: html-docs
+        path: docs/_build/html/
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/main'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/_build/html