Document image
crate integration on docs.rs
#382
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.
Right now the
image
feature injxl-oxide
crate is disabled on docs.rs. Because of that the docs on the integration do not show up on docs.rs at all. This PR fixes that.Details
doc_auto_cfg
is a nightly rustdoc feature, so it's only enabled for docs.rs to make it possible to build the docs for this crate on stable. All ways of documenting conditional features are currently nightly-only, but are also widely used so they're unlikely to outright break.You can preview the generated documentation with this command:
cargo +nightly rustdoc --open --features=image -- --cfg=docsrs
It looks like this: