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

Enable doc_cfg on docsrs feature #922

Merged
merged 2 commits into from Jun 23, 2022
Merged

Conversation

PhilippGackstatter
Copy link
Contributor

@PhilippGackstatter PhilippGackstatter commented Jun 23, 2022

Description of change

Fixes the failing build of identity_iota on docs.rs. This command succeeds now:

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

Note that #![cfg_attr(docsrs, feature(doc_cfg))] will need to be added to all crates where we start to use the #[cfg_attr(docsrs, doc(cfg(feature = "xyz")))] feature.

Links to any relevant issues

n/a

Type of change

Add an x to the boxes that are relevant to your changes.

  • Bug fix (a non-breaking change which fixes an issue)
  • Enhancement (a non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Fix

How the change has been tested

Built the docs successfully.

Change checklist

Add an x to the boxes that are relevant to your changes.

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@PhilippGackstatter PhilippGackstatter added Documentation Improvements or additions to documentation. Excludes from changelog No changelog Excludes PR from becoming part of any changelog Rust Related to the core Rust code. Becomes part of the Rust changelog. labels Jun 23, 2022
@PhilippGackstatter PhilippGackstatter added this to the v0.7 Features milestone Jun 23, 2022
@eike-hass
Copy link
Collaborator

We also need to merge this into the support/0.6 branch.

@PhilippGackstatter PhilippGackstatter merged commit dd08f3c into dev Jun 23, 2022
@PhilippGackstatter PhilippGackstatter deleted the chore/fix-docsrs-build branch June 23, 2022 15:39
eike-hass pushed a commit that referenced this pull request Jun 24, 2022
* Enable `doc_cfg` on `docsrs` feature

* Show doc feature-gate on `unstable-agent`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation. Excludes from changelog No changelog Excludes PR from becoming part of any changelog Rust Related to the core Rust code. Becomes part of the Rust changelog.
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants