From 4f3c929a6edd50530535f255cb75744d56a8cde2 Mon Sep 17 00:00:00 2001 From: Ivan Enderlin Date: Wed, 7 May 2025 14:49:44 +0200 Subject: [PATCH] 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 https://github.com/rust-lang/rust/pull/84176 to add links in the source code page. --- crates/matrix-sdk-base/Cargo.toml | 2 +- crates/matrix-sdk-common/Cargo.toml | 1 + crates/matrix-sdk-crypto/Cargo.toml | 2 +- crates/matrix-sdk-indexeddb/Cargo.toml | 2 +- crates/matrix-sdk-qrcode/Cargo.toml | 2 +- crates/matrix-sdk-sqlite/Cargo.toml | 3 +++ crates/matrix-sdk-store-encryption/Cargo.toml | 2 +- crates/matrix-sdk-ui/Cargo.toml | 3 +++ crates/matrix-sdk/Cargo.toml | 2 +- 9 files changed, 13 insertions(+), 6 deletions(-) diff --git a/crates/matrix-sdk-base/Cargo.toml b/crates/matrix-sdk-base/Cargo.toml index fe996ecb968..7f523d7a325 100644 --- a/crates/matrix-sdk-base/Cargo.toml +++ b/crates/matrix-sdk-base/Cargo.toml @@ -13,7 +13,7 @@ version = "0.11.0" [package.metadata.docs.rs] all-features = true -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [features] default = [] diff --git a/crates/matrix-sdk-common/Cargo.toml b/crates/matrix-sdk-common/Cargo.toml index 14db1ce9829..22d89cfe110 100644 --- a/crates/matrix-sdk-common/Cargo.toml +++ b/crates/matrix-sdk-common/Cargo.toml @@ -14,6 +14,7 @@ version = "0.11.0" [package.metadata.docs.rs] default-target = "x86_64-unknown-linux-gnu" targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"] +rustdoc-args = ["--generate-link-to-definition"] [features] js = ["wasm-bindgen-futures"] diff --git a/crates/matrix-sdk-crypto/Cargo.toml b/crates/matrix-sdk-crypto/Cargo.toml index 0969d5713a5..398dadc6d9d 100644 --- a/crates/matrix-sdk-crypto/Cargo.toml +++ b/crates/matrix-sdk-crypto/Cargo.toml @@ -12,7 +12,7 @@ rust-version = { workspace = true } version = "0.11.0" [package.metadata.docs.rs] -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [features] default = [] diff --git a/crates/matrix-sdk-indexeddb/Cargo.toml b/crates/matrix-sdk-indexeddb/Cargo.toml index 5c99c8a210c..b8bc8f512ec 100644 --- a/crates/matrix-sdk-indexeddb/Cargo.toml +++ b/crates/matrix-sdk-indexeddb/Cargo.toml @@ -11,7 +11,7 @@ readme = "README.md" [package.metadata.docs.rs] all-features = true default-target = "wasm32-unknown-unknown" -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [features] default = ["e2e-encryption", "state-store"] diff --git a/crates/matrix-sdk-qrcode/Cargo.toml b/crates/matrix-sdk-qrcode/Cargo.toml index 90afdb05f69..b3f136f5e9e 100644 --- a/crates/matrix-sdk-qrcode/Cargo.toml +++ b/crates/matrix-sdk-qrcode/Cargo.toml @@ -16,7 +16,7 @@ js = ["vodozemac/js"] [package.metadata.docs.rs] all-features = true -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [dependencies] byteorder = { workspace = true } diff --git a/crates/matrix-sdk-sqlite/Cargo.toml b/crates/matrix-sdk-sqlite/Cargo.toml index aba3d390da2..b54b6b5d52a 100644 --- a/crates/matrix-sdk-sqlite/Cargo.toml +++ b/crates/matrix-sdk-sqlite/Cargo.toml @@ -7,6 +7,9 @@ description = "Sqlite storage backend for matrix-sdk" license = "Apache-2.0" rust-version = { workspace = true } +[package.metadata.docs.rs] +rustdoc-args = ["--generate-link-to-definition"] + [features] default = ["state-store", "event-cache"] testing = ["matrix-sdk-crypto?/testing"] diff --git a/crates/matrix-sdk-store-encryption/Cargo.toml b/crates/matrix-sdk-store-encryption/Cargo.toml index 3bcbeb644e3..15d27b77594 100644 --- a/crates/matrix-sdk-store-encryption/Cargo.toml +++ b/crates/matrix-sdk-store-encryption/Cargo.toml @@ -8,7 +8,7 @@ license = "Apache-2.0" rust-version = { workspace = true } [package.metadata.docs.rs] -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [features] js = ["dep:getrandom", "getrandom?/js"] diff --git a/crates/matrix-sdk-ui/Cargo.toml b/crates/matrix-sdk-ui/Cargo.toml index 73c9ff2dd6c..c9632208727 100644 --- a/crates/matrix-sdk-ui/Cargo.toml +++ b/crates/matrix-sdk-ui/Cargo.toml @@ -7,6 +7,9 @@ repository = "https://github.com/matrix-org/matrix-rust-sdk" license = "Apache-2.0" rust-version = { workspace = true } +[package.metadata.docs.rs] +rustdoc-args = ["--generate-link-to-definition"] + [features] default = ["native-tls"] diff --git a/crates/matrix-sdk/Cargo.toml b/crates/matrix-sdk/Cargo.toml index 979b4ff08e7..9e0f3885a2c 100644 --- a/crates/matrix-sdk/Cargo.toml +++ b/crates/matrix-sdk/Cargo.toml @@ -13,7 +13,7 @@ version = "0.11.0" [package.metadata.docs.rs] features = ["docsrs"] -rustdoc-args = ["--cfg", "docsrs"] +rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"] [features] default = ["e2e-encryption", "automatic-room-key-forwarding", "sqlite", "native-tls"]