Skip to content

Commit df0a760

Browse files
authored
Merge pull request #101 from arielb1/doc-auto-cfg
change doc_auto_cfg to doc_cfg
2 parents e66ca9f + b15999a commit df0a760

File tree

4 files changed

+409
-486
lines changed

4 files changed

+409
-486
lines changed

.github/actions/rust-build/action.yml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,12 @@ runs:
2727
cargo test --verbose ${{ inputs.flags }}
2828
if [ "${{ inputs.toolchain }}" == nightly -a "${{ inputs.flags }}" == "--all-features" ]; then
2929
# docs use unstable features, run them on nightly
30-
RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --verbose ${{ inputs.flags }}
31-
fi
30+
# pass --no-deps. When *rendering* docs, is better to not use `--no-deps`,
31+
# since links in docs can link to types in dependencies, but currently, some crates
32+
# do not compile with `cfg(docsrs)` due to the feature gate name change
33+
# in <https://github.com/rust-lang/rust/pull/138907>.
34+
#
35+
# It's better to keep `--no-deps` in CI, since it matches what rustdoc runs, and is
36+
# faster.
37+
RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --verbose --no-deps ${{ inputs.flags }}
38+
fi

0 commit comments

Comments
 (0)