Merge pull request #1131 from GuillaumeGomez/generate-link-to-def

Use `--generate-link-to-definition` option when generating documentation

Author: sdroege

.github/workflows/docs.yml

@@ -19,7 +19,7 @@ jobs:
         0.15=0.15
         0.14=0.14
       RUSTFLAGS: --cfg docsrs
-      RUSTDOCFLAGS: --cfg docsrs
+      RUSTDOCFLAGS: --cfg docsrs -Zunstable-options --generate-link-to-definition
     steps:
       - uses: actions/checkout@v3
         with:

cairo/Cargo.toml

@@ -33,7 +33,7 @@ win32-surface = ["ffi/win32-surface"]
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies.glib]
 optional = true

gdk-pixbuf/Cargo.toml

@@ -25,7 +25,7 @@ v2_42 = ["v2_40", "ffi/v2_42"]
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

gio/Cargo.toml

@@ -35,7 +35,7 @@ v2_78 = ["v2_76", "ffi/v2_78", "glib/v2_78"]
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

glib/Cargo.toml

@@ -64,7 +64,7 @@ std_once_cell = []
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [[test]]
 name = "subclass_compiletest"

glib/src/collections/ptr_slice.rs

@@ -1072,7 +1072,7 @@ impl<T: TransparentPtrType> From<super::Slice<T>> for PtrSlice<T> {
 }
 
 // rustdoc-stripper-ignore-next
-/// A trait to accept both <code>&[T]</code> or <code>PtrSlice<T></code> as an argument.
+/// A trait to accept both `&[T]` or `PtrSlice<T>` as an argument.
 pub trait IntoPtrSlice<T: TransparentPtrType> {
     // rustdoc-stripper-ignore-next
     /// Runs the given closure with a `NULL`-terminated array.

glib/src/collections/strv.rs

@@ -1064,7 +1064,7 @@ impl From<StrV> for crate::Value {
 }
 
 // rustdoc-stripper-ignore-next
-/// A trait to accept both <code>&[T]</code> or <code>StrV</code> as an argument.
+/// A trait to accept both `&[T]` or `StrV` as an argument.
 pub trait IntoStrV {
     // rustdoc-stripper-ignore-next
     /// Runs the given closure with a `NULL`-terminated array.

glib/src/gstring_builder.rs

@@ -116,7 +116,7 @@ impl GStringBuilder {
     }
 
     // rustdoc-stripper-ignore-next
-    /// Returns <code>&[str]</code> slice.
+    /// Returns `&[str]` slice.
     #[inline]
     pub fn as_str(&self) -> &str {
         unsafe {

graphene/Cargo.toml

@@ -21,7 +21,7 @@ name = "graphene"
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

pango/Cargo.toml

@@ -26,7 +26,7 @@ v1_52 = ["v1_50", "ffi/v1_52"]
 [package.metadata.docs.rs]
 all-features = true
 rustc-args = ["--cfg", "docsrs"]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"