From b8368113ebf12a2d24d51bd24812ffb74e4e3b47 Mon Sep 17 00:00:00 2001
From: Purva Thakre <purva.athakre@gmail.com>
Date: Fri, 5 Jul 2024 16:59:12 -0500
Subject: [PATCH 1/3] create a separate docs build workflow

---
 .github/workflows/docs-build.yml | 62 ++++++++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)
 create mode 100644 .github/workflows/docs-build.yml

diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
new file mode 100644
index 000000000..91f7afa86
--- /dev/null
+++ b/.github/workflows/docs-build.yml
@@ -0,0 +1,62 @@
+name: docs-build
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+      - ready_for_review
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out mitiq
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --upgrade pip
+          make install requirements
+
+      - name: Run the quilc & qvm Docker images
+        run: |
+          docker run --rm -idt -p 5000:5000 rigetti/qvm -S
+          docker run --rm -idt -p 5555:5555 rigetti/quilc -R
+
+      - name: Generate hash from all files excluding example notebooks
+        id: gen_hash
+        run: |
+          HASH=$(find . -type f -not -path './docs/source/examples/*' | sort | xargs cat | sha256sum | awk '{print $1}')
+          echo "hash=$HASH" >> $GITHUB_OUTPUT
+
+      - name: Fetch Jupyter cache
+        uses: actions/cache@v4
+        with:
+          path: ./docs/build/.jupyter_cache
+          key: jupyter-cache-${{ steps.gen_hash.outputs.hash }}
+
+      - name: Build and test Sphinx docs
+        run: |
+          export BQSKIT_DOC_CHECK_OVERRIDE=1
+          export PYDEVD_DISABLE_FILE_VALIDATION=1
+          make docs
+
+      - name: Run linkcheck on 'release' PRs
+        if: github.event_name == 'pull_request'
+        run: |
+          pr_title_lower=$(echo "${{ github.event.pull_request.title }}" | tr '[:upper:]' '[:lower:]')
+          if [[ "$pr_title_lower" == *"release"* ]]; then
+            make linkcheck
+          fi

From f370e1f12569926746cc2afeb18a6d4121a74e2d Mon Sep 17 00:00:00 2001
From: Purva Thakre <purva.athakre@gmail.com>
Date: Fri, 5 Jul 2024 17:06:19 -0500
Subject: [PATCH 2/3] remove docs job from build.yml

---
 .github/workflows/build.yml | 46 -------------------------------------
 1 file changed, 46 deletions(-)

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index f4445af8a..6ea6a89e1 100644
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -34,52 +34,6 @@ jobs:
       - name: Check code style/formatting
         run: make check-format
 
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out mitiq
-        uses: actions/checkout@v4
-
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: "3.12"
-
-      - name: Install Python dependencies
-        run: |
-          python -m pip install --upgrade pip
-          make install requirements
-
-      - name: Run the quilc & qvm Docker images
-        run: |
-          docker run --rm -idt -p 5000:5000 rigetti/qvm -S
-          docker run --rm -idt -p 5555:5555 rigetti/quilc -R
-
-      - name: Generate hash from all files excluding example notebooks
-        id: gen_hash
-        run: |
-          HASH=$(find . -type f -not -path './docs/source/examples/*' | sort | xargs cat | sha256sum | awk '{print $1}')
-          echo "hash=$HASH" >> $GITHUB_OUTPUT
-
-      - name: Fetch Jupyter cache
-        uses: actions/cache@v4
-        with:
-          path: ./docs/build/.jupyter_cache
-          key: jupyter-cache-${{ steps.gen_hash.outputs.hash }}
-
-      - name: Build and test Sphinx docs
-        run: |
-          export BQSKIT_DOC_CHECK_OVERRIDE=1
-          export PYDEVD_DISABLE_FILE_VALIDATION=1
-          make docs
-
-      - name: Run linkcheck on 'release' PRs
-        if: github.event_name == 'pull_request'
-        run: |
-          pr_title_lower=$(echo "${{ github.event.pull_request.title }}" | tr '[:upper:]' '[:lower:]')
-          if [[ "$pr_title_lower" == *"release"* ]]; then
-            make linkcheck
-          fi
 
   # This is to make sure Mitiq works without optional 3rd party packages like Qiskit, pyQuil, etc.
   # E.g., if we accidentally `import qiskit` in Mitiq where we shouldn't, this test will catch that.

From a124cb0d1e5e11ee9b363dd752cef170bf85652c Mon Sep 17 00:00:00 2001
From: Purva Thakre <66048318+purva-thakre@users.noreply.github.com>
Date: Mon, 22 Jul 2024 18:29:48 -0500
Subject: [PATCH 3/3] Update .github/workflows/docs-build.yml

Co-authored-by: nate stemen <nate@unitary.fund>
---
 .github/workflows/docs-build.yml | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
index 91f7afa86..e71ebf0de 100644
--- a/.github/workflows/docs-build.yml
+++ b/.github/workflows/docs-build.yml
@@ -28,7 +28,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          make install requirements
+          make install
 
       - name: Run the quilc & qvm Docker images
         run: |