Merge pull request #4371 from tgross35/fix-docs

Increase the recursion limit to fix docs.rs `ctest`

Author: tgross35

.github/workflows/ci.yaml

@@ -230,6 +230,17 @@ jobs:
     - uses: Swatinem/rust-cache@v2
     - run: cargo build -p ctest
 
+  docs:
+    name: Ensure docs build
+    runs-on: ubuntu-24.04
+    timeout-minutes: 10
+    steps:
+    - uses: actions/checkout@master
+    - name: Install Rust
+      run: rustup update nightly --no-self-update && rustup default nightly
+    - uses: Swatinem/rust-cache@v2
+    - run: cargo doc --workspace --no-deps
+
   # One job that "summarizes" the success state of this pipeline. This can then be added to branch
   # protection, rather than having to add each job separately.
   success:
@@ -242,6 +253,7 @@ jobs:
       - test_tier2_vm
       - verify_build
       - ctest_msrv
+      - docs
     # Github branch protection is exceedingly silly and treats "jobs skipped because a dependency
     # failed" as success. So we have to do some contortions to ensure the job fails if any of its
     # dependencies fails.

ctest/src/lib.rs

@@ -9,6 +9,8 @@
 //!
 //! [project]: https://github.com/rust-lang/libc/blob/main/ctest/README.md
 
+// FIXME(ctest): documenting `garando_syntax` overflows otherwise
+#![recursion_limit = "256"]
 #![deny(missing_docs)]
 
 use std::collections::{HashMap, HashSet};