Skip to content

Commit 210f0b2

Browse files
thedevbirbmempirate
authored andcommitted
fix: docs build, CI for docs
1 parent d3cd7db commit 210f0b2

File tree

8 files changed

+11
-8
lines changed

8 files changed

+11
-8
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,9 +123,9 @@ jobs:
123123
cache-on-failure: true
124124

125125
- name: Check documentation
126-
run: RUSTDOCFLAGS="-D warnings" cargo +nightly doc --all --no-deps --all-features --document-private-items
126+
run: cargo +nightly doc --all --no-deps --all-features --document-private-items
127127
env:
128-
RUSTDOCFLAGS: "-D warnings"
128+
RUSTDOCFLAGS: "-D warnings --cfg docsrs"
129129

130130
# Find unused dependencies, this will fail if any are found.
131131
cargo-shear:

msg-common/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//! Common utilities and types for msg-rs.
22
33
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
4-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
4+
#![cfg_attr(docsrs, feature(doc_cfg))]
55
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
66

77
use std::{

msg-sim/Cargo.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ repository.workspace = true
1111

1212
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
1313

14+
[package.metadata.docs.rs]
15+
targets = ["x86_64-unknown-linux-gnu", "aarch64-unknown-linux-gnu"]
16+
1417
[dependencies]
1518

1619
[target.'cfg(target_os = "linux")'.dependencies]

msg-sim/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
2-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
33

44
//! In-process network emulation for Linux, powered by `rtnetlink`.
55

msg-socket/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
//! Sockets are the main entrypoint in this library and facilitate all connectivity, like binding or
99
//! connecting, and sending and receiving messages over connections.
1010
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
11-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
11+
#![cfg_attr(docsrs, feature(doc_cfg))]
1212
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
1313

1414
pub mod stats;

msg-transport/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
2-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
33
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
44

55
use std::{

msg-wire/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
2-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
33
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
44

55
pub mod auth;

msg/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#![doc(issue_tracker_base_url = "https://github.com/chainbound/msg-rs/issues/")]
2-
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
33

44
pub use msg_socket::*;
55
pub use msg_transport::*;

0 commit comments

Comments
 (0)