Skip to content

Commit

Permalink
Disable wgpu-core documentation as a workaround for #4905.
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
kpreid authored and cwfitzgerald committed Jul 19, 2024
1 parent 6cd3874 commit b5934e8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Bottom level categories:
#### General

- Fix profiling with `tracy`. By @waywardmonkeys in [#5988](https://github.com/gfx-rs/wgpu/pull/5988)
- As a workaround for [issue #4905](https://github.com/gfx-rs/wgpu/issues/4905), `wgpu-core` is undocumented unless `--cfg wgpu_core_doc` feature is enabled. By @kpreid in [#5987](https://github.com/gfx-rs/wgpu/pull/5987)

## 22.0.0 (2024-07-17)

Expand Down
14 changes: 14 additions & 0 deletions wgpu-core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@
//! It is designed for integration into browsers, as well as wrapping
//! into other language-specific user-friendly libraries.
//!
#![cfg_attr(
not(any(not(doc), wgpu_core_doc)),
doc = r#"\
## Documentation hidden
As a workaround for [an issue in rustdoc](https://github.com/rust-lang/rust/issues/114891)
that [affects `wgpu-core` documentation builds \
severely](https://github.com/gfx-rs/wgpu/issues/4905),
the documentation for `wgpu-core` is empty unless built with
`RUSTFLAGS="--cfg wgpu_core_doc"`, which may take a very long time.
"#
)]
#![cfg(any(not(doc), wgpu_core_doc))]
//!
//! ## Feature flags
#![doc = document_features::document_features!()]
//!
Expand Down

0 comments on commit b5934e8

Please sign in to comment.