Build docs.rs documentation with doc_auto_cfg
#94
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
When building documentation for docs.rs, use the `doc_auto_cfg` feature to highlight which crate features are required for a given API. The feature is not used when building docs locally, as it requires the nightly toolchain (which docs.rs already uses).
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.
When building documentation for docs.rs, use the
doc_auto_cfgfeature to highlight which crate features are required for a given API. The feature is not used when building docs locally, as it requires the nightly toolchain (which docs.rs already uses).You can check how the new docs will look by running: