docs: enable some useful rustdoc features on docs.rs

alloy-rs · Jan 5, 2025 · 0757b77 · 0757b77
1 parent 5f340ef
commit 0757b77
Show file tree

Hide file tree

Showing 11 changed files with 56 additions and 12 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,10 +12,6 @@ homepage = "https://github.com/alloy-rs/core"
 repository = "https://github.com/alloy-rs/core"
 exclude = ["tests"]
 
-[workspace.metadata.docs.rs]
-all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
-
 [workspace.lints.clippy]
 dbg-macro = "warn"
 manual-string-new = "warn"

diff --git a/crates/core/Cargo.toml b/crates/core/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/dyn-abi/Cargo.toml b/crates/dyn-abi/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/json-abi/Cargo.toml b/crates/json-abi/Cargo.toml
@@ -13,6 +13,14 @@ license.workspace = true
 repository.workspace = true
 exclude.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
+
 [dependencies]
 alloy-primitives = { workspace = true, features = ["serde"] }
 alloy-sol-type-parser = { workspace = true, features = ["serde"] }

diff --git a/crates/primitives/Cargo.toml b/crates/primitives/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/sol-macro-expander/Cargo.toml b/crates/sol-macro-expander/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/sol-macro-input/Cargo.toml b/crates/sol-macro-input/Cargo.toml
@@ -13,6 +13,14 @@ license.workspace = true
 repository.workspace = true
 exclude.workspace = true
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
+
 [dependencies]
 dunce = "1.0.4"
 heck = "0.5.0"

diff --git a/crates/sol-macro/Cargo.toml b/crates/sol-macro/Cargo.toml
@@ -18,7 +18,11 @@ proc-macro = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/sol-type-parser/Cargo.toml b/crates/sol-type-parser/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/sol-types/Cargo.toml b/crates/sol-types/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true

diff --git a/crates/syn-solidity/Cargo.toml b/crates/syn-solidity/Cargo.toml
@@ -15,7 +15,11 @@ exclude.workspace = true
 
 [package.metadata.docs.rs]
 all-features = true
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = [
+    "-Zunstable-options",
+    "--generate-link-to-definition",
+    "--show-type-layout",
+]
 
 [lints]
 workspace = true