Docsrs labels #380
Merged
Docsrs labels #380
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… rustc-serialize, which has had a history of causing builds to print deprecation warnings.
… pull in rustc-serialize, which has had a history of causing builds to print deprecation warnings." This reverts commit 36138ca.
This is a nightly-only feature, and can used locally by setting `RUSTFLAGS="--cfg docsrs"` and `RUSTDOCFLAGS="--cfg docsrs"` and then generating the documentation using `cargo +nightly doc --all-features`. Generating documentation using stable `cargo doc` (without the `--cfg docsrs`) should work just as normal.
|
LGTM - thanks for the suggestion! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
rustdoc/docs.rs support adding cfg/feature labels to generated docs, but it's currently nightly only and put behind a feature gate. Apparently there are some future goals to make generation of these automatic, but for now it requires adding the entries manually. docs.rs happens to use nightly to generate docs, so we can make use of that while retaining compatibility with stable rustdoc.
With these changes,
cargo docwill work the same as it always has, but following the added instructions in the readme will yield labels like the ones (for instance) tokio has: https://docs.rs/tokio/1.42.0/tokio/#modules