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

docs: enable nightly-only docsrs #76

Merged
merged 1 commit into from
Nov 22, 2024
Merged

docs: enable nightly-only docsrs #76

merged 1 commit into from
Nov 22, 2024

Conversation

m4tx
Copy link
Contributor

@m4tx m4tx commented Nov 21, 2024

See rust-lang/rust#43781. This enables infoboxes like "Available on crate feature XXX only." in the documentation generated using cargo doc on nightly, or by building on docs.rs.

This can be tested with:

RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features

See rust-lang/rust#43781. This enables infoboxes like
"Available on crate feature XXX only." in the documentation generated
using `cargo doc` on nightly, or by building on docs.rs.

This can be tested with:

```shell
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --no-deps --all-features
```
@m4tx
Copy link
Contributor Author

m4tx commented Nov 21, 2024

Example:
image

@m4tx m4tx requested review from seqre and Iipin November 21, 2024 15:17
Copy link

codecov bot commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
rust 82.79% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
flareon/src/lib.rs 57.00% <ø> (ø)

🚨 Try these New Features:

Copy link
Contributor

@seqre seqre left a comment

Choose a reason for hiding this comment

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

LGTM

@m4tx m4tx merged commit e718f8b into master Nov 22, 2024
21 of 23 checks passed
@m4tx m4tx deleted the doc_auto_cfg branch November 22, 2024 08:49
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