Skip to content

Show feature gated bindings in documentaion #187

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

Merged
merged 4 commits into from
Aug 24, 2022

Conversation

minghuaw
Copy link
Contributor

This PR simply asks docs.rs to build the crate with all features enabled and label the specific feature needed for a particular binding. This can be tested locally with the following command

cargo +nightly doc --no-deps --all-features --open -Z unstable-options --config 'build.rustdocflags=[\"--cfg\", \"docsrs\"]'

@minghuaw minghuaw force-pushed the docsrs-all-features branch from cb78aa3 to 2eed196 Compare August 18, 2022 19:49
@minghuaw
Copy link
Contributor Author

@slinkydeveloper Could you please give a quick look at this? This PR contains zero change to the rust code. It's just some quality of life improvement on docs.rs

Signed-off-by: minghuaw <michael.wu1107@gmail.com>
Signed-off-by: minghuaw <michael.wu1107@gmail.com>
Signed-off-by: minghuaw <michael.wu1107@gmail.com>
Signed-off-by: minghuaw <michael.wu1107@gmail.com>
@minghuaw minghuaw force-pushed the docsrs-all-features branch from a8393cc to e978051 Compare August 24, 2022 13:18
@jcrossley3
Copy link
Contributor

Thanks @minghuaw

Sorry for the delay -- I'm on vacation til Sept -- I'll check the AMQP PR then if nobody else has.

@jcrossley3 jcrossley3 merged commit b8487af into cloudevents:main Aug 24, 2022
minghuaw added a commit to minghuaw/sdk-rust that referenced this pull request Aug 26, 2022
* show feature gated bindings in docsrs

* moved crate root docsrs feature

* fixed cargo fmt check

* removed files that should go with another PR

Signed-off-by: minghuaw <michael.wu1107@gmail.com>
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