From 6fc7a7f140bff72a18109743bf841e31c0610bb4 Mon Sep 17 00:00:00 2001 From: thedevbirb Date: Mon, 16 Feb 2026 12:00:46 +0100 Subject: [PATCH] fix: docs build, CI for docs --- .github/workflows/ci.yml | 4 ++-- msg-common/src/lib.rs | 2 +- msg-sim/Cargo.toml | 3 +++ msg-sim/src/lib.rs | 2 +- msg-socket/src/lib.rs | 2 +- msg-transport/src/lib.rs | 2 +- msg-wire/src/lib.rs | 2 +- msg/src/lib.rs | 2 +- 8 files changed, 11 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cd9a9f33..58c347c7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -123,9 +123,9 @@ jobs: cache-on-failure: true - name: Check documentation - run: RUSTDOCFLAGS="-D warnings" cargo +nightly doc --all --no-deps --all-features --document-private-items + run: cargo +nightly doc --all --no-deps --all-features --document-private-items env: - RUSTDOCFLAGS: "-D warnings" + RUSTDOCFLAGS: "-D warnings --cfg docsrs" # Find unused dependencies, this will fail if any are found. cargo-shear: diff --git a/msg-common/src/lib.rs b/msg-common/src/lib.rs index e8178d60..7d37b37b 100644 --- a/msg-common/src/lib.rs +++ b/msg-common/src/lib.rs @@ -1,7 +1,7 @@ //! Common utilities and types for msg-rs. #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] #![cfg_attr(not(test), warn(unused_crate_dependencies))] use std::{ diff --git a/msg-sim/Cargo.toml b/msg-sim/Cargo.toml index 89784f9c..90ac6d0d 100644 --- a/msg-sim/Cargo.toml +++ b/msg-sim/Cargo.toml @@ -11,6 +11,9 @@ repository.workspace = true # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html +[package.metadata.docs.rs] +targets = ["x86_64-unknown-linux-gnu", "aarch64-unknown-linux-gnu"] + [dependencies] [target.'cfg(target_os = "linux")'.dependencies] diff --git a/msg-sim/src/lib.rs b/msg-sim/src/lib.rs index 908e8bf6..2751a3fd 100644 --- a/msg-sim/src/lib.rs +++ b/msg-sim/src/lib.rs @@ -1,5 +1,5 @@ #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] //! In-process network emulation for Linux, powered by `rtnetlink`. diff --git a/msg-socket/src/lib.rs b/msg-socket/src/lib.rs index 21167795..d47d2c1b 100644 --- a/msg-socket/src/lib.rs +++ b/msg-socket/src/lib.rs @@ -8,7 +8,7 @@ //! Sockets are the main entrypoint in this library and facilitate all connectivity, like binding or //! connecting, and sending and receiving messages over connections. #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] #![cfg_attr(not(test), warn(unused_crate_dependencies))] pub mod stats; diff --git a/msg-transport/src/lib.rs b/msg-transport/src/lib.rs index 87543274..e5b6e4f8 100644 --- a/msg-transport/src/lib.rs +++ b/msg-transport/src/lib.rs @@ -1,5 +1,5 @@ #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] #![cfg_attr(not(test), warn(unused_crate_dependencies))] use std::{ diff --git a/msg-wire/src/lib.rs b/msg-wire/src/lib.rs index 41703d1a..5231c6dd 100644 --- a/msg-wire/src/lib.rs +++ b/msg-wire/src/lib.rs @@ -1,5 +1,5 @@ #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] #![cfg_attr(not(test), warn(unused_crate_dependencies))] pub mod auth; diff --git a/msg/src/lib.rs b/msg/src/lib.rs index 681e14f7..f7772c20 100644 --- a/msg/src/lib.rs +++ b/msg/src/lib.rs @@ -1,5 +1,5 @@ #![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")] -#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))] +#![cfg_attr(docsrs, feature(doc_cfg))] pub use msg_socket::*; pub use msg_transport::*;