Merge branch 'main' of https://github.com/photon-circus/ph-esp32-mac

Author: swgiacomelli

.github/workflows/ci.yml

@@ -109,3 +109,23 @@ jobs:
         run: cargo doc --manifest-path Cargo.toml --no-deps
         env:
           RUSTDOCFLAGS: -D warnings
+
+  docsrs:
+    name: Docs (simulate docs.rs on nightly)
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Rust (nightly)
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          toolchain: nightly
+      - name: Cache cargo
+        uses: Swatinem/rust-cache@v2
+      - name: Build docs like docs.rs
+        env:
+          DOCS_RS: "1"
+          RUSTDOCFLAGS: "--cfg docsrs --cap-lints warn"
+        run: |
+          cargo +nightly doc --lib --no-deps \
+            --features "smoltcp,critical-section,async,embassy-net,log,defmt"
+        

Cargo.toml

@@ -76,8 +76,10 @@ embassy-net-driver = { version = "0.2", optional = true }
 critical-section = { version = "1.2", features = ["std"] }
 
 [package.metadata.docs.rs]
+default-target = "xtensa-esp32-none-elf"
 features = ["smoltcp", "critical-section", "async", "embassy-net", "log", "defmt"]
 rustdoc-args = ["--cfg", "docsrs"]
+cargo-args = ["-Z", "build-std=core"]
 
 # =============================================================================
 # Integration Test Dependencies (only needed when building for target hardware)

src/lib.rs

@@ -83,9 +83,9 @@
 //! With default configuration (10 RX buffers, 10 TX buffers, 1600 bytes each):
 //! - Total: ~32 KB of DMA-capable SRAM
 
+#![no_std]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![cfg_attr(docsrs, doc(cfg_hide(feature = "esp32p4")))]
-#![no_std]
 #![deny(missing_docs)]
 #![allow(unsafe_code)]
 #![deny(unsafe_op_in_unsafe_fn)]