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

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

.github/workflows/CI.yml

@@ -70,15 +70,11 @@ jobs:
       # not nightly
       # clippy
       - run: rustup component add clippy
-        if: matrix.rust == 'beta' || matrix.rust == 'stable'
+        if: matrix.rust == 'stable'
       - working-directory: ${{ matrix.conf.name }}
         name: clippy ${{ matrix.conf.name }}
         run: cargo clippy --all-targets -- -D warnings
         if: matrix.rust == 'stable'
-      - working-directory: ${{ matrix.conf.name }}
-        name: clippy ${{ matrix.conf.name }}
-        run: cargo clippy --all-targets
-        if: matrix.rust == 'beta'
       # tests
       - name: tests (rust ${{ matrix.rust }})
         run: xvfb-run --auto-servernum cargo test --manifest-path ${{ matrix.conf.name }}/Cargo.toml --features "${{ matrix.conf.features }}"

.github/workflows/docs.yml

@@ -37,6 +37,9 @@ jobs:
       - run: python3 ./generator.py --embed-docs --yes ./
       - run: git clone https://gitlab.gnome.org/World/Rust/gir-rustdoc/ # checkout action doesn't support random urls
       - run: echo "RUSTDOCFLAGS=$(eval python3 ./gir-rustdoc/gir-rustdoc.py --pages-url 'https://gtk-rs.org/gtk3-rs/' --default-branch 'master' pre-docs | xargs)" >> ${GITHUB_ENV}
+        env:
+          RUSTDOCFLAGS: >
+            -Zunstable-options --generate-link-to-definition
       - uses: actions-rs/cargo@v1
         with:
           command: doc

atk/Cargo.toml

@@ -24,7 +24,7 @@ v2_34 = ["v2_32", "ffi/v2_34"]
 v2_38 = ["v2_34", "ffi/v2_38"]
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

gdk/Cargo.toml

@@ -23,7 +23,7 @@ v3_24 = ["ffi/v3_24"]
 unsafe-assume-initialized = []
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

gdkwayland/Cargo.toml

@@ -17,7 +17,7 @@ v3_24 = ["ffi/v3_24", "gdk/v3_24"]
 v3_24_22 = ["v3_24", "ffi/v3_24_22"]
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 ffi = { path = "./sys", package = "gdkwayland-sys" }

gdkx11/Cargo.toml

@@ -20,7 +20,7 @@ name = "gdkx11"
 v3_24 = ["ffi/v3_24_2"]
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [dependencies]
 libc = "0.2"

gtk/Cargo.toml

@@ -29,7 +29,7 @@ gio_v2_58 = ["gio/v2_58"]
 unsafe-assume-initialized = []
 
 [package.metadata.docs.rs]
-rustdoc-args = ["--cfg", "docsrs"]
+rustdoc-args = ["--cfg", "docsrs", "--generate-link-to-definition"]
 
 [build-dependencies]
 pkg-config = "0.3.7"