docs: add root level documentation for all libraries #3202
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's this all about?
This PR adds crate-/root-level documentation for all library crates. All crates except
windows-implement
andwindows-interface
, import the documentation (with doctests) from theirREADME.md
.windows-sys
andwindows
include examples with some required features. Rustdoc can't infer them, so the inclusion of the README is only done if they're enabled. Forwindows
this also checks ifdocsrs
isn't set (although docs.rs should build without any enabled features).Doctests are running in CI with
cargo test --doc -p <crate>
and documentation is generated withcargo doc --no-deps -p <crate>
.You can verify the output with
Fixes: #3187