Skip to content

Document features for docs.rs #2367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -134,3 +134,6 @@ zip = { version = "2.2.3", default-features = false, features = ["deflate"] }

[workspace.lints.clippy]
large_futures = "deny"

[workspace.lints.rust]
unexpected_cfgs = { level = "warn", check-cfg = ['cfg(docsrs)'] }
3 changes: 3 additions & 0 deletions sdk/core/azure_core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@ tokio_process = ["dep:tokio", "tokio/process"]
tokio_sleep = ["typespec_client_core/tokio_sleep"]
xml = ["typespec_client_core/xml"]

[lints]
workspace = true

[package.metadata.docs.rs]
features = [
"hmac_openssl",
Expand Down
2 changes: 1 addition & 1 deletion sdk/core/azure_core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

#![forbid(unsafe_code)]
#![deny(missing_debug_implementations, nonstandard_style)]
// #![warn(missing_docs, future_incompatible, unreachable_pub)]
#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[macro_use]
mod macros;
Expand Down
3 changes: 3 additions & 0 deletions sdk/core/azure_core_amqp/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,8 @@ fe2o3_amqp = [
"serde_bytes",
]

[lints]
workspace = true

[package.metadata.docs.rs]
features = ["fe2o3_amqp"]
1 change: 1 addition & 0 deletions sdk/core/azure_core_amqp/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[cfg(all(feature = "fe2o3_amqp", not(target_arch = "wasm32")))]
mod fe2o3;
Expand Down
3 changes: 3 additions & 0 deletions sdk/eventhubs/azure_messaging_eventhubs/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ azure_core_test.workspace = true
azure_identity.workspace = true
tokio = { workspace = true, features = ["rt-multi-thread", "macros", "time"] }
tracing-subscriber = { workspace = true, features = ["env-filter", "fmt"] }

[lints]
workspace = true
1 change: 1 addition & 0 deletions sdk/eventhubs/azure_messaging_eventhubs/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
#![recursion_limit = "128"]
#![warn(missing_docs)]
#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

pub(crate) mod common;

Expand Down
3 changes: 3 additions & 0 deletions sdk/identity/azure_identity/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ client_certificate = ["openssl"]
# https://github.com/Azure/azure-cli/issues/19700
old_azure_cli = ["time/local-offset", "tz-rs"]

[lints]
workspace = true

[package.metadata.docs.rs]
features = [
"client_certificate",
Expand Down
1 change: 1 addition & 0 deletions sdk/identity/azure_identity/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

mod authorization_code_flow;
mod azure_pipelines_credential;
Expand Down
3 changes: 3 additions & 0 deletions sdk/typespec/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,6 @@ default = ["http", "json"]
http = []
json = ["dep:serde", "dep:serde_json"]
amqp = []

[lints]
workspace = true
1 change: 1 addition & 0 deletions sdk/typespec/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

pub mod error;
#[cfg(feature = "http")]
Expand Down
3 changes: 3 additions & 0 deletions sdk/typespec/typespec_client_core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,6 @@ features = [
"tokio_sleep",
"xml",
]

[lints]
workspace = true
1 change: 1 addition & 0 deletions sdk/typespec/typespec_client_core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
// Licensed under the MIT License.

#![doc = include_str!("../README.md")]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

#[macro_use]
mod macros;
Expand Down