Documentation failing to build for docs.rs

RustAudio / coreaudio-rs

A friendly rust interface to Apple's Core Audio API.

Apache License 2.0

203 stars 38 forks source link

Documentation failing to build for docs.rs #78

Open mitchmindtree opened 3 years ago

mitchmindtree commented 3 years ago

Despite specifying the macos target for documentation to build in our Cargo.toml, the build will still fail when building for docs.rs. This is because docs.rs attempts to build for macOS via cross-compilation from Linux. This should be first solved in coreaudio-sys before attempting to fix coreaudio-rs.

Related issues / PRs:

https://github.com/RustAudio/coreaudio-sys/issues/40
https://github.com/RustAudio/coreaudio-sys/pull/38
https://github.com/rust-lang/docs.rs/issues/853

HEnquist commented 2 years ago

I had similar issue with a crate for windows, where I simply worked around the problem by hosting the docs on GitHub pages instead. See https://henquist.github.io/wasapi-rs/ The docs are built from the "docs" branch of the repo. Would that be an acceptable solution here too?