Fixed failing documentation builds without the embedded-hal feature.

Author: newAM

.github/workflows/ci.yml

@@ -15,10 +15,10 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-      - run: RUSTFLAGS="-D warnings" cargo build --verbose --no-default-features
-      - run: RUSTFLAGS="-D warnings" cargo build --verbose --no-default-features --features embedded-hal
-      - run: RUSTFLAGS="-D warnings" cargo build --verbose --no-default-features --features std
-      - run: RUSTFLAGS="-D warnings" cargo build --verbose --all-features
+      - run: RUSTFLAGS="-D warnings" cargo build --no-default-features
+      - run: RUSTFLAGS="-D warnings" cargo build --no-default-features --features embedded-hal
+      - run: RUSTFLAGS="-D warnings" cargo build --no-default-features --features std
+      - run: RUSTFLAGS="-D warnings" cargo build --all-features
 
   test:
     name: Unit Tests
@@ -28,7 +28,7 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
-      - run: cargo test --verbose --all-features
+      - run: cargo test --all-features
 
   clippy_check:
     name: Clippy
@@ -63,6 +63,9 @@ jobs:
       - uses: actions-rs/toolchain@v1
         with:
           toolchain: stable
+      - run: cargo doc --no-default-features
+      - run: cargo doc --no-default-features --features embedded-hal
+      - run: cargo doc --no-default-features --features std
       - run: cargo doc --all-features
 
   rustdoc:

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.1] - 2021-02-06
+### Fixed
+- Fixed failing documentation builds without the `embedded-hal` feature.
+
 ## [0.5.0] - 2021-02-06
 ### Added
 - Added the `Default` trait for `DuplexStatus`, `LinkStatus`, and `SpeedStatus`.
@@ -66,7 +70,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.0] - 2021-01-02
 - Initial release
 
-[Unreleased]: https://github.com/newAM/w5500-ll-rs/compare/v0.5.0...HEAD
+[Unreleased]: https://github.com/newAM/w5500-ll-rs/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/newAM/w5500-ll-rs/compare/v0.5.0...v0.5.1
 [0.5.0]: https://github.com/newAM/w5500-ll-rs/compare/v0.4.0...v0.5.0
 [0.4.0]: https://github.com/newAM/w5500-ll-rs/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/newAM/w5500-ll-rs/compare/v0.2.1...v0.3.0

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "w5500-ll"
-version = "0.5.0"
+version = "0.5.1"
 authors = ["Alex M. <[email protected]>"]
 edition = "2018"
 repository = "https://github.com/newAM/w5500-ll-rs"

README.md

@@ -47,6 +47,6 @@ By default only the `embedded-hal` feature is enabled.
 [w5500-hl]: https://github.com/newAM/w5500-hl-rs
 [w5500-regsim]: https://github.com/newAM/w5500-regsim-rs
 [Wiznet W5500]: https://www.wiznet.io/product-item/w5500/
-[`blocking`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/blocking/index.html
-[`Registers`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/trait.Registers.html
-[`w5500_ll::net`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/net/index.html
+[`blocking`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/blocking/index.html
+[`Registers`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/trait.Registers.html
+[`w5500_ll::net`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/net/index.html

src/lib.rs

@@ -50,16 +50,16 @@
 //! [w5500-hl]: https://github.com/newAM/w5500-hl-rs
 //! [w5500-regsim]: https://github.com/newAM/w5500-regsim-rs
 //! [Wiznet W5500]: https://www.wiznet.io/product-item/w5500/
-//! [`blocking`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/blocking/index.html
-//! [`Registers`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/trait.Registers.html
-//! [`w5500_ll::net`]: https://docs.rs/w5500-ll/0.5.0/w5500_ll/net/index.html
-#![doc(html_root_url = "https://docs.rs/w5500-ll/0.5.0")]
+//! [`blocking`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/blocking/index.html
+//! [`Registers`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/trait.Registers.html
+//! [`w5500_ll::net`]: https://docs.rs/w5500-ll/0.5.1/w5500_ll/net/index.html
+#![doc(html_root_url = "https://docs.rs/w5500-ll/0.5.1")]
 #![cfg_attr(docsrs, feature(doc_cfg))]
 #![forbid(unsafe_code)]
 #![deny(missing_docs)]
 #![cfg_attr(not(feature = "std"), no_std)]
 
-#[cfg(any(feature = "embedded-hal", doc))]
+#[cfg(feature = "embedded-hal")]
 #[cfg_attr(docsrs, doc(cfg(feature = "embedded-hal")))]
 pub mod blocking;
 pub mod net;

src/spi.rs

@@ -103,7 +103,7 @@ pub const fn fdm_header_4b(address: u16, block: u8, mode: AccessMode) -> [u8; HE
 /// Recommended W5500 SPI mode.
 ///
 /// The W5500 may operate in SPI mode 0 or SPI mode 3.
-#[cfg(any(feature = "embedded-hal", doc))]
+#[cfg(feature = "embedded-hal")]
 #[cfg_attr(docsrs, doc(cfg(feature = "embedded-hal")))]
 pub const MODE: embedded_hal::spi::Mode = embedded_hal::spi::Mode {
     polarity: embedded_hal::spi::Polarity::IdleLow,