Skip to content

Commit

Permalink
Disable wgpu-core documentation as a workaround for gfx-rs#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 committed Jul 18, 2024
1 parent 80921f4 commit a75aef0
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions wgpu-core/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,12 @@ fragile-send-sync-non-atomic-wasm = [
"wgt/fragile-send-sync-non-atomic-wasm",
]

## Enable full documentation.
## If this feature is not enabled, some items will be undocumented.
## This feature is a workaround for <https://github.com/rust-lang/rust/issues/114891>
## to enable projects which do not need `wgpu-core` documentation to still use `cargo doc`.
wgpu-core-doc = []

#! ### Backends, passed through to wgpu-hal
# --------------------------------------------------------------------

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

0 comments on commit a75aef0

Please sign in to comment.