From 80aea82a131595557403c1b2607bb9e0233aff05 Mon Sep 17 00:00:00 2001
From: Chang Sun <chsun@cern.ch>
Date: Sun, 26 Nov 2023 21:43:08 -0800
Subject: [PATCH] publish-page action

---
 .github/workflows/sphinx-build.yml | 57 ++++++++++++++++++++++++++++++
 pyproject.toml                     |  2 +-
 2 files changed, 58 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/sphinx-build.yml

diff --git a/.github/workflows/sphinx-build.yml b/.github/workflows/sphinx-build.yml
new file mode 100644
index 0000000..40a3804
--- /dev/null
+++ b/.github/workflows/sphinx-build.yml
@@ -0,0 +1,57 @@
+name: Sphinx document with GitHub Pages dependencies preinstalled
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["master"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          pip3 install ".[docs]"
+      - name: Build
+        run: |
+          cd docs
+          make html
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          # Upload entire repository
+          path: 'docs/_build/html'
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2
diff --git a/pyproject.toml b/pyproject.toml
index 730a3a1..cb3828b 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -28,7 +28,7 @@ repository = "https://github.com/calad0i/HGQ"
 write_to = "src/HGQ/_version.py"
 
 [project.optional-dependencies]
-doc = ["sphinx", "sphinx-rtd-theme", "myst-parser", "qkeras", "pyparsing"]
+docs = ["sphinx", "sphinx-rtd-theme", "myst-parser", "qkeras", "pyparsing"]
 
 test = [
   # "git+https://github.com/calad0i/hls4ml@HGQ-integration",