-
Notifications
You must be signed in to change notification settings - Fork 933
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Disable wgpu-core documentation as a workaround for #4905. #5987
Conversation
f4858e1
to
61e28ce
Compare
Ah, nice workaround, we can also re-enable building docs in CI (currently also commented out) |
Would it be possible to add re-enabling CI to this PR? |
Besides not building docs, there's a bunch of stale workaround stuff (just search for “4905” in comments), so I'd rather leave that to a separate PR in case of further messes. |
Oh, wait, I see — if we just enable the docs build now, then this PR gets that aspect tested. Okay. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing, thanks!
Head branch was pushed to by a user without write access
Fixed changelog merge conflict. Adjusting the CI script made me think: perhaps the “document wgpu-core anyway” should actually not be a |
Hmmm, I think I like the cfg better as wanting this is going to be rare as it's so un-useful |
This enables `cargo doc` to succeed in a reasonable amount of time, as long as the reader isn't looking for documentation for `wgpu-core` itself.
This reverts most of the changes in a2fcd72, but the "document private features" step is still disabled since it operates only on wgpu-core which is exactly the problem.
Done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Noice
Connections
Proposed workaround for #4905.
Description
This enables
cargo doc
to succeed in a reasonable amount of time, as long as the reader isn't looking for documentation forwgpu-core
itself.Testing
Manually ran
cargo doc
and observed it succeeded, and checked the resultingwgpu-core
andwgpu
documentation.Checklist
cargo fmt
.cargo clippy
. If applicable, add:--target wasm32-unknown-unknown
--target wasm32-unknown-emscripten
cargo xtask test
to run tests.CHANGELOG.md
. See simple instructions inside file.