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: generate docs for all features on docs.rs #767

Merged
merged 3 commits into from May 13, 2022

Conversation

niklasad1
Copy link
Member

No description provided.

@niklasad1 niklasad1 requested a review from a team as a code owner May 12, 2022 16:00

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

Choose a reason for hiding this comment

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

What does this do?

Copy link
Member Author

Choose a reason for hiding this comment

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

By default docs.rs only builds the docs with default-features so we want all features to be documented.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Ah thanks, and the --cfg docsrs bit is about making it possible to conditionally compile stuff for doc purposes I gather!

Copy link
Member Author

@niklasad1 niklasad1 May 13, 2022

Choose a reason for hiding this comment

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

should be equivalent to RUSTDOCFLAGS="--cfg docrs" cargo doc

@niklasad1 niklasad1 requested a review from a team as a code owner May 13, 2022 10:41
@niklasad1 niklasad1 merged commit d821c7b into master May 13, 2022
@niklasad1 niklasad1 deleted the na-generate-docs-behind-features branch May 13, 2022 11:31
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.

None yet

3 participants