WIP: cargo test --doc

.github/actions/setup-ocaml/action.yml

@@ -0,0 +1,13 @@
+name: "Shared OCaml setting up steps"
+description: "Shared OCaml setting up steps"
+inputs:
+  ocaml_version:
+    description: "OCaml version"
+    required: true
+runs:
+  using: "composite"
+  steps:
+    - name: Setup OCaml ${{ inputs.ocaml_version }}
+      uses: ocaml/setup-ocaml@v3
+      with:
+        ocaml-compiler: ${{ inputs.ocaml_version }}

.github/workflows/ci.yaml

@@ -111,6 +111,29 @@ jobs:
       - name: Test p2p crate
         run: make test-p2p
 
+  doc-tests:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Git checkout
+        uses: actions/checkout@v5
+
+      - name: Setup build dependencies
+        uses: ./.github/actions/setup-build-deps
+
+      - name: Setup OCaml
+        uses: ./.github/actions/setup-ocaml
+        with:
+          ocaml-compiler: 4.14.2
+
+      - name: Setup Rust
+        uses: ./.github/actions/setup-rust
+        with:
+          toolchain: 1.84
+          cache-prefix: doc-tests-v0
+
+      - name: Run documentation tests
+        run: make test-doc
+
   build:
     # NOTE: If you add or remove platforms from this matrix, make sure to update
     # the documentation at website/docs/developers/getting-started.mdx

Makefile

@@ -234,6 +234,10 @@ test-release: ## Run tests in release mode
 test-vrf: ## Run VRF tests, requires nightly Rust
 	@cd vrf && cargo +nightly test --release -- -Z unstable-options --report-time
 
+.PHONY: test-doc
+test-doc: ## Run documentation tests
+	cargo test --doc --all-features
+
 # Docker build targets
 
 .PHONY: docker-build-all