Add link from docs.rs to full API documentation #2297
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.
This attempts to help with discovery for people who find Rust documentation directly via docs.rs and not the crates.io readme. The wording chosen hopefully makes it clear that it's not necessarily the same version as the docs.rs page (note that old versions on crates.io have the same issue). I guess we could have something about building old docs locally for that case but that's probably better left to the FAQ if it's desired.
The docs.rs documentation can be generated locally by setting
$env:RUSTDOCFLAGS = "--cfg docsrs"
. Though obviously testing properly would require actually publishing it, unfortunately.Fixes: #2296