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

Document image crate integration on docs.rs #382

Merged
merged 1 commit into from
Nov 5, 2024

Conversation

Shnatsel
Copy link
Contributor

@Shnatsel Shnatsel commented Nov 5, 2024

Right now the image feature in jxl-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:
Screenshot from 2024-11-05 12 11 49

Copy link
Owner

@tirr-c tirr-c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh I've absolutely missed that, thanks!

@tirr-c tirr-c merged commit 4eb023a into tirr-c:main Nov 5, 2024
4 checks passed
@Shnatsel
Copy link
Contributor Author

Shnatsel commented Nov 5, 2024

A point release including this would be very welcome, so that I could promote the integration on social media and link to the docs.rs page directly.

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.

2 participants