-
Notifications
You must be signed in to change notification settings - Fork 1
Description
Motivation
The crates in our workspace have documentation only targeting rust packages for "x86_64-unknown-linux-gnu". It is located in the [package.metadata.docs.rs] section on Cargo.toml of each crate.
Although it has nothing to do with the programme functionality, it still might not make the code compile, hence the need to have a version that targets every OS.
For now, we have only added every known target to make it compatible with Mac M1 and Windows as they might have issues compiling with the default ("x86_64-unknown-linux-gnu").
[package.metadata.docs.rs]
targets = ["x86_64-unknown-linux-gnu", "x86_64-apple-darwin", "x86_64-pc-windows-msvc", "aarch64-apple-darwin"]
However, we need to add their custom doc.
Suggested Solution
Rust has a guide about Doc.rs documentation here https://docs.rs/about