adding workflows for docs

Author: quentinhaenn

.github/workflows/sphinx.yml

@@ -0,0 +1,28 @@
+name: "Sphinx: Render docs"
+
+on:
+  push:
+    branches:
+      - main
+      - docs
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+    - uses: actions/checkout@v4
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+    - 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

docs/requirements.txt

@@ -0,0 +1,8 @@
+sphinx>=8.1.3
+sphinx_gallery>=0.18.0
+sphinx-copybutton>=0.5.2
+pydata-sphinx-theme>=0.15.3
+sphinxcontrib-email>=0.3.6
+sphinx-remove-toctrees>=1.0.0
+sphinx-prompt>=1.9.0
+sphinx_design>=0.6.1