Skip to content

Commit 3efc5f9

Browse files
authored
chore(doc): Replace doc_auto_cfg config with doc_cfg (#2428)
## Motivation `doc_auto_cfg` was merged into `doc_cfg` in rust-lang/rust#138907. ## Solution Replaces `doc_auto_cfg` config with `doc_cfg`. And uses `cargo-docs-rs` to check with the same options used by docs.rs.
1 parent ed4bafc commit 3efc5f9

File tree

5 files changed

+14
-5
lines changed

5 files changed

+14
-5
lines changed

.github/workflows/CI.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,16 @@ jobs:
308308
- uses: Swatinem/rust-cache@v2
309309
# we exlude crates that do not use rust-version = { workspace = true }
310310
- run: cargo no-dev-deps --no-private check --all-features --workspace --exclude grpc --exclude tonic-protobuf\*
311-
- run: cargo no-dev-deps --no-private doc --no-deps --all-features --workspace --exclude grpc --exclude tonic-protobuf\*
311+
312+
doc:
313+
runs-on: ubuntu-latest
314+
steps:
315+
- uses: actions/checkout@v5
316+
- uses: dtolnay/rust-toolchain@nightly
317+
- uses: dtolnay/install@cargo-docs-rs
318+
- uses: taiki-e/install-action@cargo-hack
319+
- uses: Swatinem/rust-cache@v2
320+
- run: cargo +nightly hack --no-private docs-rs
312321
env:
313322
RUSTDOCFLAGS: "-D warnings"
314323

tonic-build/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
)]
66
#![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
77
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
8-
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
8+
#![cfg_attr(docsrs, feature(doc_cfg))]
99

1010
use proc_macro2::{Delimiter, Group, Ident, Literal, Punct, Spacing, Span, TokenStream};
1111
use quote::TokenStreamExt;

tonic-health/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
)]
1212
#![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
1313
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
14-
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
14+
#![cfg_attr(docsrs, feature(doc_cfg))]
1515

1616
use std::fmt::{Display, Formatter};
1717

tonic-reflection/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
)]
66
#![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
77
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
8-
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
8+
#![cfg_attr(docsrs, feature(doc_cfg))]
99

1010
mod generated {
1111
#![allow(unreachable_pub)]

tonic/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@
9797
)]
9898
#![doc(issue_tracker_base_url = "https://github.com/hyperium/tonic/issues/")]
9999
#![doc(test(no_crate_inject, attr(deny(rust_2018_idioms))))]
100-
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
100+
#![cfg_attr(docsrs, feature(doc_cfg))]
101101

102102
pub mod body;
103103
pub mod client;

0 commit comments

Comments
 (0)