Skip to content

Commit

Permalink
[ci] Re-enable cargo doc --document-private-items in CI
Browse files Browse the repository at this point in the history
Re-enable CI checks that naga, wgpu-core, and wgpu-hal documentation
builds without warnings, even with `--document-private-items`. This
was previously disabled due to gfx-rs#4905, which causes long build times,
but with the de-generification of `wgpu_core`, that's no longer a
problem: a build of all three crates' docs now takes only 7s.
  • Loading branch information
jimblandy committed Sep 5, 2024
1 parent aeac0f2 commit 3ed5753
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -220,20 +220,18 @@ jobs:
# build docs
cargo doc --target ${{ matrix.target }} --all-features --no-deps
# wgpu-core docs are not feasible due to <https://github.com/gfx-rs/wgpu/issues/4905>
#
# - name: check private item docs
# if: matrix.kind == 'native'
# shell: bash
# run: |
# set -e
#
# # wgpu_core package
# cargo +${{ env.DOCS_RUST_VERSION }} doc --target ${{ matrix.target }} \
# --package wgpu-core \
# --package wgpu-hal \
# --package naga \
# --all-features --no-deps --document-private-items
- name: check private item docs
if: matrix.kind == 'native'
shell: bash
run: |
set -e
# wgpu_core package
cargo +${{ env.DOCS_RUST_VERSION }} doc --target ${{ matrix.target }} \
--package wgpu-core \
--package wgpu-hal \
--package naga \
--all-features --no-deps --document-private-items
# We run minimal checks on the MSRV of the core crates, ensuring that
# its dependency tree does not cause issues for firefox.
Expand Down

0 comments on commit 3ed5753

Please sign in to comment.