Skip to content

Commit 2aaba4c

Browse files
committed
doc: Generate doc with --generate-link-to-definition.
This patch adds the `--generate-link-to-definition` argument to `rustdoc` for `docs.rs`. This is using rust-lang/rust#84176 to add links in the source code page.
1 parent 8be0a7d commit 2aaba4c

File tree

9 files changed

+13
-6
lines changed

9 files changed

+13
-6
lines changed

crates/matrix-sdk-base/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ version = "0.11.0"
1313

1414
[package.metadata.docs.rs]
1515
all-features = true
16-
rustdoc-args = ["--cfg", "docsrs"]
16+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
1717

1818
[features]
1919
default = []

crates/matrix-sdk-common/Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ version = "0.11.0"
1414
[package.metadata.docs.rs]
1515
default-target = "x86_64-unknown-linux-gnu"
1616
targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]
17+
rustdoc-args = ["--generate-link-to-definition"]
1718

1819
[features]
1920
js = ["wasm-bindgen-futures"]

crates/matrix-sdk-crypto/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ rust-version = { workspace = true }
1212
version = "0.11.0"
1313

1414
[package.metadata.docs.rs]
15-
rustdoc-args = ["--cfg", "docsrs"]
15+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
1616

1717
[features]
1818
default = []

crates/matrix-sdk-indexeddb/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ readme = "README.md"
1111
[package.metadata.docs.rs]
1212
all-features = true
1313
default-target = "wasm32-unknown-unknown"
14-
rustdoc-args = ["--cfg", "docsrs"]
14+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
1515

1616
[features]
1717
default = ["e2e-encryption", "state-store"]

crates/matrix-sdk-qrcode/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ js = ["vodozemac/js"]
1616

1717
[package.metadata.docs.rs]
1818
all-features = true
19-
rustdoc-args = ["--cfg", "docsrs"]
19+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
2020

2121
[dependencies]
2222
byteorder = { workspace = true }

crates/matrix-sdk-sqlite/Cargo.toml

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ description = "Sqlite storage backend for matrix-sdk"
77
license = "Apache-2.0"
88
rust-version = { workspace = true }
99

10+
[package.metadata.docs.rs]
11+
rustdoc-args = ["--generate-link-to-definition"]
12+
1013
[features]
1114
default = ["state-store", "event-cache"]
1215
testing = ["matrix-sdk-crypto?/testing"]

crates/matrix-sdk-store-encryption/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ license = "Apache-2.0"
88
rust-version = { workspace = true }
99

1010
[package.metadata.docs.rs]
11-
rustdoc-args = ["--cfg", "docsrs"]
11+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
1212

1313
[features]
1414
js = ["dep:getrandom", "getrandom?/js"]

crates/matrix-sdk-ui/Cargo.toml

+3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ repository = "https://github.com/matrix-org/matrix-rust-sdk"
77
license = "Apache-2.0"
88
rust-version = { workspace = true }
99

10+
[package.metadata.docs.rs]
11+
rustdoc-args = ["--generate-link-to-definition"]
12+
1013
[features]
1114
default = ["native-tls"]
1215

crates/matrix-sdk/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ version = "0.11.0"
1313

1414
[package.metadata.docs.rs]
1515
features = ["docsrs"]
16-
rustdoc-args = ["--cfg", "docsrs"]
16+
rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
1717

1818
[features]
1919
default = ["e2e-encryption", "automatic-room-key-forwarding", "sqlite", "native-tls"]

0 commit comments

Comments
 (0)