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

Show all features in documentation using docsrs #78

Merged
merged 9 commits into from
May 9, 2024
Merged

Conversation

Wollac
Copy link
Contributor

@Wollac Wollac commented Apr 23, 2024

fixes #64

This will show all Modules, Traits, ... that are behind feature flags and add a "Available on crate feature host only." label on https://docs.rs.

Since cargo doc is also run in the CI, we might want to update this to a (nightly) version that also supports the --cfg docsrs flag, e.g.

      - uses: dtolnay/rust-toolchain@nightly
      - run: cargo doc --workspace --all-features --no-deps
        env:
          RUSTDOCFLAGS: "--cfg docsrs -D warnings"

@Wollac Wollac changed the title doc all features for view call using docsrs Show all features in documentation using docsrs Apr 23, 2024
@nategraf nategraf self-requested a review April 30, 2024 16:14
@nategraf
Copy link
Contributor

Need to update cargo doc in CI to use nightly

@nategraf nategraf marked this pull request as ready for review May 9, 2024 17:47
@nategraf
Copy link
Contributor

nategraf commented May 9, 2024

I've added a docs.rs job which installs the nightly toolchain and does not install cargo-risczero or Foundry.
77a8c66

@nategraf nategraf enabled auto-merge (squash) May 9, 2024 21:55
@nategraf nategraf merged commit 80e5785 into main May 9, 2024
8 of 9 checks passed
@nategraf nategraf deleted the chore/feature-docs branch May 9, 2024 22:00
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.

Document feature flags for view call proof lib on docs.rs
2 participants