Skip to content

Enable doc_auto_cfg on docsrs #58

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 2, 2025
Merged

Enable doc_auto_cfg on docsrs #58

merged 1 commit into from
Apr 2, 2025

Conversation

stefnotch
Copy link
Contributor

This displays all the features in docs.rs.

image

I tested it locally with

cd crates/wesl
RUSTDOCFLAGS="--cfg docsrs" 
cargo +nightly doc --all-features

I can't wait for doc_auto_cfg to become stable. The tracking issue is rust-lang/rust#43781

Then we can get rid of the docsrs hack, and it'd just be

cd crates/wesl
cargo doc --all-features

@k2d222
Copy link
Collaborator

k2d222 commented Mar 23, 2025

thanks! I'll see if it works with cargo publish then merge it.

@k2d222 k2d222 merged commit fd2ccbc into wgsl-tooling-wg:main Apr 2, 2025
lolbinarycat
lolbinarycat reviewed Apr 10, 2025
View reviewed changes
crates/wesl/Cargo.toml
@@ -35,3 +35,4 @@ mutable_key_type = "allow"

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
Copy link

Choose a reason for hiding this comment

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

I don't think this is required, see https://docs.rs/about/builds

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lolbinarycat lolbinarycat lolbinarycat left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stefnotch @k2d222 @lolbinarycat