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

fix docs #366

Merged
merged 2 commits into from
May 24, 2024
Merged

fix docs #366

merged 2 commits into from
May 24, 2024

Conversation

flavio
Copy link
Member

@flavio flavio commented May 23, 2024

When building the docs, provide additional information about which feature makes a module/struct/function/method available.

Fix some warnings returned by cargo doc. The warnings were caused by broken internal references.

Finally, build the documentation as part of PRs. Fail when something wrong is found while building the docs.

When building the docs, provide additional information about which
feature makes a module/struct/function/method available.

On top of that, fix some warnings returned by `cargo doc`. The warnings
were caused by broken internal references.

Signed-off-by: Flavio Castelli <fcastelli@suse.com>
Build the documentation as part of PRs. Fail when something wrong is
found while building the docs.

Signed-off-by: Flavio Castelli <fcastelli@suse.com>
@flavio flavio requested a review from Xynnn007 May 23, 2024 17:17
Copy link
Member

@Xynnn007 Xynnn007 left a comment

Choose a reason for hiding this comment

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

Great! We could foresee this would do help a lot!

@@ -44,7 +47,13 @@ sign = ["sigstore_protobuf_specs", "fulcio", "rekor", "cert"]
verify = ["sigstore_protobuf_specs", "fulcio", "rekor", "cert"]
bundle = ["sign", "verify"]

sigstore-trust-root = ["sigstore_protobuf_specs", "futures-util", "tough", "regex", "tokio/sync"]
sigstore-trust-root = [
Copy link
Member

Choose a reason for hiding this comment

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

Not any suggestions to here, just wonder: which tool/how do you re-format the toml format here?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm using taplo, I've got enabled inside of my vim setup

@flavio flavio merged commit ededdd8 into sigstore:main May 24, 2024
7 checks passed
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