search

andrewdavidmackenzie / pigg

Raspberry Pi GPIO GUI
Apache License 2.0
157 stars 8 forks source link

Add metadata for docs.rs #393

Open andrewdavidmackenzie opened 3 weeks ago

andrewdavidmackenzie commented 3 weeks ago

https://docs.rs/crate/pigg/latest/features

says

"There is very little structured metadata to build this page from currently. You should check the main library docs, readme, or Cargo.toml in case the author documented the features in them."

see if we can add meta-data about features to make this better, especially as we are about to add too more.

andrewdavidmackenzie commented 3 weeks ago

I see this in some other repos:

[package.metadata.embassy_docs]
src_base = "https://github.com/embassy-rs/embassy/blob/embassy-time-v$VERSION/embassy-time/src/"
src_base_git = "https://github.com/embassy-rs/embassy/blob/$COMMIT/embassy-time/src/"
features = ["defmt", "std"]
target = "x86_64-unknown-linux-gnu"

[package.metadata.docs.rs]
features = ["defmt", "std"]