fixup! build: Add riot-rs{-,::}coap (crate setup & docs CI)

chrysn-pull-requests · Oct 28, 2024 · 83a551b · 83a551b
1 parent 46cf4c2
commit 83a551b
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 6 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,executor-thread,external-interrupts,hwrng,i2c,no-boards,random,spi,threading,usb,coap,riot-rs-coap/doc
+          cargo doc -p riot-rs --features bench,coap,csprng,executor-thread,external-interrupts,hwrng,i2c,no-boards,random,riot-rs-coap/doc,spi,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
@@ -246,7 +246,7 @@ jobs:
       - run: echo 'RUSTFLAGS=' >> $GITHUB_ENV
 
       - name: rustdoc
-        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features bench,csprng,executor-thread,external-interrupts,hwrng,i2c,no-boards,random,spi,storage,threading,usb
+        run: RUSTDOCFLAGS='-D warnings' cargo doc -p riot-rs --features bench,coap,csprng,executor-thread,external-interrupts,hwrng,i2c,no-boards,random,riot-rs-coap/doc,spi,storage,threading,usb
 
       - name: rustdoc for ESP32
         run: RUSTDOCFLAGS='-D warnings --cfg context="esp32c6"' cargo doc --target=riscv32imac-unknown-none-elf --features external-interrupts,i2c,spi,esp-hal/esp32c6,esp-hal-embassy/esp32c6 -p riot-rs-esp

diff --git a/src/riot-rs-coap/Cargo.toml b/src/riot-rs-coap/Cargo.toml
@@ -16,6 +16,10 @@ riot-rs-random.workspace = true
 workspace = true
 
 [features]
-## Enable an arbitrary set of features in dependencies where dependencies fail
+## Enables an arbitrary set of features in dependencies where dependencies fail
 ## if no features are configured at all.
 doc = ["embassy-net/proto-ipv6", "embassy-net/medium-ip"]
+
+# Only around while we carry the embedded-nal-async impl
+proto-ipv4 = ["embassy-net/proto-ipv4"]
+proto-ipv6 = ["embassy-net/proto-ipv6"]
diff --git a/src/riot-rs-coap/src/lib.rs b/src/riot-rs-coap/src/lib.rs
@@ -1,5 +1,4 @@
-//! A CoAP stack preconfigured for RIOT-rs
-//! ======================================
+//! A CoAP stack preconfigured for RIOT-rs.
 //!
 //! This crate mainly provides easy-to-use wrappers around the [`coapcore`] crate, with presets
 //! tailored towards RIOT-rs: It utilizes [`embassy_net`] to open a network accessible CoAP socket,

diff --git a/src/riot-rs/Cargo.toml b/src/riot-rs/Cargo.toml
@@ -48,7 +48,9 @@ random = ["riot-rs-random"]
 csprng = ["riot-rs-random/csprng"]
 ## Enables seeding the random number generator from hardware.
 hwrng = ["riot-rs-embassy/hwrng"]
-## Enables the [`coap`] module
+
+#! ## Network protocols
+## Enables support for [CoAP](https://future-proof-iot.github.io/RIOT-rs/dev/docs/book/tooling/coap.html).
 coap = ["riot-rs-coap", "random", "csprng"]
 
 #! ## Serial communication