doc: allow wgpu doc on apple

This commit is contained in:
chyyran 2024-08-09 00:25:04 -04:00 committed by Ronny Chan
parent 899fb50da6
commit 3b9514ad38

View file

@ -318,18 +318,7 @@ pub mod runtime {
#[cfg(feature = "runtime-wgpu")] #[cfg(feature = "runtime-wgpu")]
#[doc(cfg(feature = "runtime-wgpu"))] #[doc(cfg(feature = "runtime-wgpu"))]
/// Shader runtime for wgpu. /// Shader runtime for wgpu.
#[cfg_attr(
all(
feature = "runtime-wgpu",
all(target_vendor = "apple", feature = "docsrs")
),
doc = "\n\nThe wgpu runtime is available on macOS and iOS, but technical reasons prevent them from rendering on docs.rs.
\n\n This is because wgpu on macOS and iOS link to [metal-rs](https://github.com/gfx-rs/metal-rs), which can not build on docs.rs.
See [SSheldon/rustc-objc-exception#13](https://github.com/SSheldon/rust-objc-exception/issues/13) for more details.
\n\n The wgpu runtime is identical for all supported operating systems, so please refer to documentation from another operating system."
)]
pub mod wgpu { pub mod wgpu {
#[cfg(not(all(target_vendor = "apple", feature = "docsrs")))]
pub use librashader_runtime_wgpu::{ pub use librashader_runtime_wgpu::{
error, error,
options::{ options::{