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 link from docs.rs to full API documentation #2297

Merged
merged 1 commit into from
Jan 23, 2023

Conversation

ChrisDenton
Copy link
Collaborator

@ChrisDenton ChrisDenton commented Jan 20, 2023

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

@kennykerr kennykerr merged commit 19a991e into microsoft:master Jan 23, 2023
@ChrisDenton ChrisDenton deleted the docsrs branch January 23, 2023 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bug: README no longer links to API docs
3 participants