chore: enable feature(doc_cfg, doc_auto_cfg) (#67)

.github/workflows/ci.yml

@@ -57,9 +57,9 @@ jobs:
             - uses: dtolnay/rust-toolchain@nightly
               with:
                   components: rust-docs
-            - run: cargo doc --workspace --no-deps --document-private-items
+            - run: cargo doc --workspace --all-features --no-deps --document-private-items
               env:
-                  RUSTDOCFLAGS: "-D warnings"
+                  RUSTDOCFLAGS: "--cfg docsrs -D warnings"
 
     fmt:
         name: fmt

Cargo.toml

@@ -10,6 +10,10 @@ license = "MIT OR Apache-2.0"
 homepage = "https://github.com/ethers-rs/core"
 repository = "https://github.com/ethers-rs/core"
 
+[workspace.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [workspace.dependencies]
 # workspace crates
 ethers-dyn-abi = { version = "0.1.0", path = "crates/dyn-abi", default-features = false }

crates/dyn-abi/Cargo.toml

@@ -13,6 +13,10 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 ethers-sol-types = { workspace = true, features = ["eip712-serde"] }
 ethers-primitives.workspace = true

crates/dyn-abi/src/lib.rs

@@ -18,6 +18,7 @@
 )]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 #[macro_use]
 extern crate alloc;

crates/primitives/Cargo.toml

@@ -13,6 +13,10 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 # eth
 ruint = { workspace = true, features = ["serde"] }

crates/primitives/src/lib.rs

@@ -7,6 +7,7 @@
 )]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 #[macro_use]
 extern crate alloc;

crates/rlp-derive/Cargo.toml

@@ -16,6 +16,10 @@ repository.workspace = true
 [lib]
 proc-macro = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 proc-macro2.workspace = true
 quote.workspace = true

crates/rlp-derive/src/lib.rs

@@ -10,6 +10,7 @@
 
 #![warn(missing_docs, unreachable_pub)]
 #![deny(unused_must_use, unused_crate_dependencies)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 extern crate proc_macro;
 

crates/rlp/Cargo.toml

@@ -13,6 +13,10 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 arrayvec.workspace = true
 bytes.workspace = true

crates/rlp/src/lib.rs

@@ -37,6 +37,7 @@ fn main() {
 )]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 #[macro_use]
 #[allow(unused_imports)]

crates/sol-macro/Cargo.toml

@@ -16,6 +16,10 @@ repository.workspace = true
 [lib]
 proc_macro = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 syn-solidity.workspace = true
 

crates/sol-macro/src/lib.rs

@@ -8,6 +8,7 @@
 
 #![warn(missing_docs)]
 #![deny(unused_must_use, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 extern crate syn_solidity as ast;
 

crates/sol-types/Cargo.toml

@@ -13,6 +13,10 @@ license.workspace = true
 homepage.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 ethers-primitives.workspace = true
 ethers-sol-macro.workspace = true

crates/sol-types/src/lib.rs

@@ -150,6 +150,7 @@
 )]
 #![deny(unused_must_use, rust_2018_idioms)]
 #![cfg_attr(not(feature = "std"), no_std)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 #[macro_use]
 extern crate alloc;

crates/syn-solidity/Cargo.toml

@@ -13,6 +13,10 @@ authors.workspace = true
 license.workspace = true
 repository.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]
+
 [dependencies]
 proc-macro2.workspace = true
 quote.workspace = true

crates/syn-solidity/src/lib.rs

@@ -1,6 +1,7 @@
 #![doc = include_str!("../README.md")]
 #![warn(unreachable_pub, unused_crate_dependencies)]
 #![deny(unused_must_use, rust_2018_idioms)]
+#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
 
 extern crate proc_macro;