archive-gh-me/wgpu
1
0
Fork 0
mirror of https://github.com/gfx-rs/wgpu.git synced 2025-12-08 21:26:17 +00:00
Code Issues Projects Releases Wiki Activity

[ci] Re-enable cargo doc --document-private-items in CI (#6224)

Browse Source 
[ci] Re-enable `cargo doc --document-private-items` in CI

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 #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.

---------

Co-authored-by: Erich Gubler <erichdongubler@gmail.com>
This commit is contained in:
Jim Blandy 2024-09-05 12:28:47 -07:00 committed by GitHub
parent 81963e24ca
commit 0b93030582
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
.github/workflows/ci.yml vendored
View File

@ -220,20 +220,18 @@ jobs:
# build docs # build docs
cargo doc --target ${{ matrix.target }} --all-features --no-deps 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'
# - name: check private item docs shell: bash
# if: matrix.kind == 'native' run: |
# shell: bash set -e
# run: |
# set -e # wgpu_core package
# cargo doc --target ${{ matrix.target }} \
# # wgpu_core package --package wgpu-core \
# cargo +${{ env.DOCS_RUST_VERSION }} doc --target ${{ matrix.target }} \ --package wgpu-hal \
# --package wgpu-core \ --package naga \
# --package wgpu-hal \ --all-features --no-deps --document-private-items
# --package naga \
# --all-features --no-deps --document-private-items
# We run minimal checks on the MSRV of the core crates, ensuring that # We run minimal checks on the MSRV of the core crates, ensuring that
# its dependency tree does not cause issues for firefox. # its dependency tree does not cause issues for firefox.