introduce CI

.github/workflows/ci-book.yml

@@ -0,0 +1,30 @@
+# This workflow ensures the book can still be built.
+# CI checking of Python code in the book happens in the regular CI pytest.
+
+name: CI - Book building
+
+on:
+  # Trigger the workflow on push or pull request,
+  # but only for the main branch, and if the book
+  # has been modified.
+  push:
+    branches:
+      - main
+    paths:
+      - docs/book/**
+  pull_request:
+    paths:
+      - docs/book/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/[email protected]
+        with:
+          mdbook-version: '0.4.37'
+
+      - run: mdbook build docs/book

.github/workflows/ci-core.yml

@@ -49,3 +49,9 @@ jobs:
         export PYTHONPATH=$(pwd)
         lit -v tests/filecheck/
         lit -v docs/Toy/examples/
+    
+    - name: Execute book tests
+      run: |
+        for f in docs/book/**/*.py; do
+          python "$f";
+        done

docs/book/book.toml

@@ -4,3 +4,6 @@ language = "en"
 multilingual = false
 src = "src"
 title = "The xDSL Book"
+
+[build]
+create-missing = false

docs/book/src/starting.md

@@ -1,3 +1,7 @@
 # Starting an xDSL project
 
 TODO: installation steps, environment setup
+
+```py
+{{#include starting.py:test_op}}
+```

docs/book/src/starting.py

@@ -0,0 +1,9 @@
+from xdsl.irdl import IRDLOperation, irdl_op_definition
+
+# fmt: off
+
+# ANCHOR: test_op
+@irdl_op_definition
+class SomeTestOp(IRDLOperation):
+    name = "some.test"
+# ANCHOR_END: test_op