From 7e7b9520233a2e45eb73bcc956c46b13aa65c118 Mon Sep 17 00:00:00 2001
From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com>
Date: Wed, 24 Jan 2024 10:50:06 +1300
Subject: [PATCH] Docs: add test-docs.yml

---
 .github/workflows/test-docs.yml | 42 +++++++++++++++++++++++++++++++++
 docs/Makefile                   |  6 +++++
 2 files changed, 48 insertions(+)
 create mode 100644 .github/workflows/test-docs.yml

diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml
new file mode 100644
index 00000000000..16892dbd273
--- /dev/null
+++ b/.github/workflows/test-docs.yml
@@ -0,0 +1,42 @@
+name: Build and test doc code samples
+
+on:
+  pull_request:
+    branches:
+    - main
+
+jobs:
+  test-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install Dependencies
+        shell: bash
+        run: |
+          sudo apt-get update
+          sudo apt-get install gperf build-essential bison flex libreadline-dev gawk tcl-dev libffi-dev git graphviz xdot pkg-config python python3 libboost-system-dev libboost-python-dev libboost-filesystem-dev zlib1g-dev
+
+      - name: Setup GCC
+        uses: Dup4/actions-setup-gcc@v1
+
+      - name: Runtime environment
+        shell: bash
+        env:
+          WORKSPACE: ${{ github.workspace }}
+        run: |
+          echo "GITHUB_WORKSPACE=`pwd`" >> $GITHUB_ENV
+          echo "$GITHUB_WORKSPACE/.local/bin" >> $GITHUB_PATH
+          echo "procs=$(nproc)" >> $GITHUB_ENV
+
+      - name: Checkout Yosys
+        uses: actions/checkout@v3
+
+      - name: Build yosys
+        shell: bash
+        run: |
+          make config-gcc
+          make -j${{ env.procs }}
+
+      - name: Run tests
+        shell: bash
+        run: |
+          make -C docs test -j${{ env.procs }}
diff --git a/docs/Makefile b/docs/Makefile
index 2319e1665c3..41b24f937b5 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -224,3 +224,9 @@ dummy:
 	$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy
 	@echo
 	@echo "Build finished. Dummy builder generates no files."
+
+PYTHON ?= python3
+
+.PHONY: test
+test:
+	$(PYTHON) tests/macro_commands.py