Add --generate-link-to-definition option when building on docs.rs

rust-random · Jul 15, 2023 · 8042ccb · 8042ccb
1 parent ee80b41
commit 8042ccb
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 3 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -19,9 +19,9 @@ include = ["src/", "LICENSE-*", "README.md", "CHANGELOG.md", "COPYRIGHT"]
 
 [package.metadata.docs.rs]
 # To build locally:
-# RUSTDOCFLAGS="--cfg doc_cfg" cargo +nightly doc --all-features --no-deps --open
+# RUSTDOCFLAGS="--cfg doc_cfg" cargo +nightly doc --all-features --no-deps --generate-link-to-definition --open
 all-features = true
-rustdoc-args = ["--cfg", "doc_cfg"]
+rustdoc-args = ["--cfg", "doc_cfg", "--generate-link-to-definition"]
 
 [package.metadata.playground]
 features = ["small_rng", "serde1"]

diff --git a/rand_chacha/Cargo.toml b/rand_chacha/Cargo.toml
@@ -15,6 +15,9 @@ categories = ["algorithms", "no-std"]
 edition = "2021"
 rust-version = "1.56"
 
+[package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
+
 [dependencies]
 rand_core = { path = "../rand_core", version = "0.7.0" }
 ppv-lite86 = { version = "0.2.14", default-features = false, features = ["simd"] }

diff --git a/rand_core/Cargo.toml b/rand_core/Cargo.toml
@@ -19,7 +19,7 @@ rust-version = "1.56"
 # To build locally:
 # RUSTDOCFLAGS="--cfg doc_cfg" cargo +nightly doc --all-features --no-deps --open
 all-features = true
-rustdoc-args = ["--cfg", "doc_cfg"]
+rustdoc-args = ["--cfg", "doc_cfg", "--generate-link-to-definition"]
 
 [package.metadata.playground]
 all-features = true

diff --git a/rand_distr/Cargo.toml b/rand_distr/Cargo.toml
@@ -16,6 +16,9 @@ edition = "2021"
 rust-version = "1.56"
 include = ["src/", "LICENSE-*", "README.md", "CHANGELOG.md", "COPYRIGHT"]
 
+[package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
+
 [features]
 default = ["std"]
 std = ["alloc", "rand/std"]

diff --git a/rand_pcg/Cargo.toml b/rand_pcg/Cargo.toml
@@ -15,6 +15,9 @@ categories = ["algorithms", "no-std"]
 edition = "2021"
 rust-version = "1.56"
 
+[package.metadata.docs.rs]
+rustdoc-args = ["--generate-link-to-definition"]
+
 [features]
 serde1 = ["serde"]