ci(docs): enable rendering the documentation of thread_executor (#429)

future-proof-iot · Sep 18, 2024 · 84e5e67 · 84e5e67
2 parents 8e799e2 + 808a816
commit 84e5e67
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/.github/workflows/build-deploy-docs.yml b/.github/workflows/build-deploy-docs.yml
@@ -48,7 +48,7 @@ jobs:
 
       - name: Build rustdoc docs
         run: |
-          cargo doc -p riot-rs --features bench,csprng,external-interrupts,hwrng,no-boards,random,threading,usb
+          cargo doc -p riot-rs --features bench,csprng,executor-thread,external-interrupts,hwrng,no-boards,random,threading,usb
           echo "<meta http-equiv=\"refresh\" content=\"0; url=riot_rs\">" > target/doc/index.html
           mkdir -p ./_site/dev/docs/api && mv target/doc/* ./_site/dev/docs/api
 

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -185,7 +185,7 @@ jobs:
           args: --verbose --locked --features external-interrupts,embassy-stm32/stm32wb55rg -p riot-rs-stm32
 
       - name: rustdoc
-        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features bench,csprng,external-interrupts,hwrng,no-boards,random,threading,usb
+        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features bench,csprng,executor-thread,external-interrupts,hwrng,no-boards,random,threading,usb
 
       - name: rustdoc for ESP32
         run: RUSTDOCFLAGS='-D warnings' cargo doc --target=riscv32imac-unknown-none-elf --features external-interrupts,esp-hal/esp32c6,esp-hal-embassy/esp32c6 -p riot-rs-esp

diff --git a/src/riot-rs-embassy/src/thread_executor.rs b/src/riot-rs-embassy/src/thread_executor.rs
@@ -1,3 +1,6 @@
+//! Provides an executor that should run inside a thread.
+#![deny(missing_docs)]
+
 // This is based on the upstream embassy cortex-m interrupt executor.
 
 use core::marker::PhantomData;