doc: quarto deployment of notebooks

Author: meilame-tayebjee

.github/workflows/deploy-notebooks.yml

@@ -0,0 +1,34 @@
+name: Publish Quarto Notebooks
+
+on:
+  push:
+    branches:
+      - main
+      - notebook_output
+
+jobs:
+  build-deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0     # Needed to push to gh-pages
+
+      - name: Setup Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Render notebooks site
+        run: |
+          cd notebooks
+          quarto render
+
+      - name: Deploy Quarto notebooks to gh-pages/notebooks
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: gh-pages
+          publish_dir: notebooks/_site
+          destination_dir: notebooks
+          keep_files: true   # <-- keeps existing Sphinx docs untouched

.gitignore

@@ -178,3 +178,8 @@ poetry.lock
 .vscode/
 
 benchmark_results/
+
+example_files/
+_site/
+.quarto/
+**/*.quarto_ipynb

notebooks/_quarto.yml

@@ -0,0 +1,5 @@
+project:
+  type: website
+
+website:
+  title: "Example notebooks"