From da04339f5ed75fd299c03b7d0fc3b6405be7b8c5 Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Fri, 30 Aug 2024 11:22:29 +0200 Subject: [PATCH] Enable rustdoc `generate-link-to-definition` feature on docs.rs (#5030) You can see this feature in action [here](https://docs.rs/sysinfo/latest/src/sysinfo/common/system.rs.html#46) or on any of dtolnay's crates and many others. I found myself going through your project code recently on docs.rs and I was a bit sad I couldn't have this feature enabled. This should fix it at next release. :) --- crates/ecolor/Cargo.toml | 1 + crates/eframe/Cargo.toml | 1 + crates/egui-wgpu/Cargo.toml | 2 +- crates/egui-winit/Cargo.toml | 2 +- crates/egui/Cargo.toml | 1 + crates/egui_demo_app/Cargo.toml | 1 + crates/egui_demo_lib/Cargo.toml | 1 + crates/egui_extras/Cargo.toml | 1 + crates/egui_glow/Cargo.toml | 2 +- crates/emath/Cargo.toml | 1 + crates/epaint/Cargo.toml | 1 + crates/epaint_default_fonts/Cargo.toml | 1 + 12 files changed, 12 insertions(+), 3 deletions(-) diff --git a/crates/ecolor/Cargo.toml b/crates/ecolor/Cargo.toml index 0fc55464..c1a10070 100644 --- a/crates/ecolor/Cargo.toml +++ b/crates/ecolor/Cargo.toml @@ -21,6 +21,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/eframe/Cargo.toml b/crates/eframe/Cargo.toml index b438bdea..1621458e 100644 --- a/crates/eframe/Cargo.toml +++ b/crates/eframe/Cargo.toml @@ -22,6 +22,7 @@ include = [ [package.metadata.docs.rs] all-features = true targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"] +rustdoc-args = ["--generate-link-to-definition"] [lints] workspace = true diff --git a/crates/egui-wgpu/Cargo.toml b/crates/egui-wgpu/Cargo.toml index 647016e3..88b81b0c 100644 --- a/crates/egui-wgpu/Cargo.toml +++ b/crates/egui-wgpu/Cargo.toml @@ -28,7 +28,7 @@ workspace = true [package.metadata.docs.rs] all-features = true - +rustdoc-args = ["--generate-link-to-definition"] [features] default = [] diff --git a/crates/egui-winit/Cargo.toml b/crates/egui-winit/Cargo.toml index 4060442f..4472c70f 100644 --- a/crates/egui-winit/Cargo.toml +++ b/crates/egui-winit/Cargo.toml @@ -18,7 +18,7 @@ workspace = true [package.metadata.docs.rs] all-features = true - +rustdoc-args = ["--generate-link-to-definition"] [features] default = ["clipboard", "links", "wayland", "winit/default", "x11"] diff --git a/crates/egui/Cargo.toml b/crates/egui/Cargo.toml index a920df2b..487a4eac 100644 --- a/crates/egui/Cargo.toml +++ b/crates/egui/Cargo.toml @@ -18,6 +18,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/egui_demo_app/Cargo.toml b/crates/egui_demo_app/Cargo.toml index 827b14fb..b1905356 100644 --- a/crates/egui_demo_app/Cargo.toml +++ b/crates/egui_demo_app/Cargo.toml @@ -13,6 +13,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] crate-type = ["cdylib", "rlib"] diff --git a/crates/egui_demo_lib/Cargo.toml b/crates/egui_demo_lib/Cargo.toml index 88c2e855..cc41e923 100644 --- a/crates/egui_demo_lib/Cargo.toml +++ b/crates/egui_demo_lib/Cargo.toml @@ -24,6 +24,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/egui_extras/Cargo.toml b/crates/egui_extras/Cargo.toml index 8d1cb543..b13a518e 100644 --- a/crates/egui_extras/Cargo.toml +++ b/crates/egui_extras/Cargo.toml @@ -22,6 +22,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/egui_glow/Cargo.toml b/crates/egui_glow/Cargo.toml index 3a2ac677..094d537d 100644 --- a/crates/egui_glow/Cargo.toml +++ b/crates/egui_glow/Cargo.toml @@ -24,7 +24,7 @@ workspace = true [package.metadata.docs.rs] all-features = true - +rustdoc-args = ["--generate-link-to-definition"] [features] default = [] diff --git a/crates/emath/Cargo.toml b/crates/emath/Cargo.toml index f47f281c..6df0da9a 100644 --- a/crates/emath/Cargo.toml +++ b/crates/emath/Cargo.toml @@ -18,6 +18,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/epaint/Cargo.toml b/crates/epaint/Cargo.toml index 88ed8eb4..7815189d 100644 --- a/crates/epaint/Cargo.toml +++ b/crates/epaint/Cargo.toml @@ -23,6 +23,7 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"] [lib] diff --git a/crates/epaint_default_fonts/Cargo.toml b/crates/epaint_default_fonts/Cargo.toml index 9cb05fc0..8d31507d 100644 --- a/crates/epaint_default_fonts/Cargo.toml +++ b/crates/epaint_default_fonts/Cargo.toml @@ -27,3 +27,4 @@ workspace = true [package.metadata.docs.rs] all-features = true +rustdoc-args = ["--generate-link-to-definition"]