From f7b8b9e1f1a0e764b95918e2433cff8cdef9190e Mon Sep 17 00:00:00 2001
From: Seyon Sivarajah <seyon.sivarajah@quantinuum.com>
Date: Mon, 17 Jun 2024 10:59:26 +0100
Subject: [PATCH] add docs build workflow

---
 .github/workflows/docs.yml | 55 ++++++++++++++++++++++++++++++++++++++
 .gitignore                 |  2 ++
 2 files changed, 57 insertions(+)
 create mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 0000000..91e485b
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,55 @@
+name: Build and publish docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+
+# 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.
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build docs.
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python '3.10'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: "pip"
+      - name: Install Tierkreis
+        run: pip install ."[typecheck]"
+      - name: Build docs
+        run: |
+          cd docs
+          ./build.sh
+      - name: Upload artifact.
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build/
+
+  publish:
+    name: Publish docs.
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Deploy to GitHub Pages.
+        id: deployment
+        uses: actions/deploy-pages@v4
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 61e9164..e652560 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
 ./venv
 tierkreis/core/protos/
+*.egg-info/
+**/__pycache__/
\ No newline at end of file