Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom Docs.rs for Mac M1 and Windows #12

Open
seun-ja opened this issue Aug 19, 2021 · 0 comments
Open

Add custom Docs.rs for Mac M1 and Windows #12

seun-ja opened this issue Aug 19, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@seun-ja
Copy link
Contributor

seun-ja commented Aug 19, 2021

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

@seun-ja seun-ja added the enhancement New feature or request label Aug 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant