Check for broken doc links in CI

bamler-lab · Aug 26, 2024 · 4f37e82 · 4f37e82
1 parent 3a07233
commit 4f37e82
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -37,6 +37,14 @@ jobs:
           RUSTFLAGS: "-D warnings"
         run: cargo clippy --all-targets --all-features
 
+      # The environment variable `RUSTFLAGS` doesn't actually seem to have any effect on rustdoc,
+      # but we set it here to the same value as in all other cargo runs as changing it would
+      # cause unnecessary recompilation of some dependencies.
+      - name: Check for broken doc links
+        env:
+          RUSTFLAGS: "-D warnings"
+        run: cargo rustdoc -- -D rustdoc::broken-intra-doc-links
+
       - name: Test in development mode
         env:
           RUSTFLAGS: "-D warnings"

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
@@ -49,6 +49,14 @@ jobs:
           RUSTFLAGS: "-D warnings"
         run: cargo clippy --all-targets --all-features
 
+      # The environment variable `RUSTFLAGS` doesn't actually seem to have any effect on rustdoc,
+      # but we set it here to the same value as in all other cargo runs as changing it would
+      # cause unnecessary recompilation of some dependencies.
+      - name: Check for broken doc links
+        env:
+          RUSTFLAGS: "-D warnings"
+        run: cargo rustdoc -- -D rustdoc::broken-intra-doc-links
+
       - name: Test in development mode
         env:
           RUSTFLAGS: "-D warnings"