From e045c66c357382e50e735e095fbc0719632bb3c3 Mon Sep 17 00:00:00 2001
From: ROMemories <romain.fouquet@inria.fr>
Date: Fri, 23 Feb 2024 14:00:37 +0100
Subject: [PATCH] ci(rustdoc): check rustdoc generation

---
 .github/workflows/main.yml | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 92499f7a3..106ff7aaa 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -80,6 +80,24 @@ jobs:
       with:
         args: --verbose --locked -p riot-rs-embassy
 
+  rustdoc:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out repository code
+      uses: actions/checkout@v4
+
+    - name: Install toolchain
+      uses: dtolnay/rust-toolchain@nightly
+
+    - name: rust cache
+      uses: Swatinem/rust-cache@v2
+
+    # TODO: we'll eventually want to generate docs for riot-rs instead
+    # TODO: we'll eventually want to enable relevant features
+    - name: "rustdoc generation check"
+      run: cargo rustdoc -p riot-rs-embassy -- -D warnings
+
   CI-success:
       if: ${{ always() }}
       runs-on: ubuntu-latest