You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR added Cargo metadata and crate-level attributes to get docs building with additional information on docs.rs. In particular, this will get feature-gates APIs (e.g. the Prover trait) to show up on docs.rs.
It also introduces a new CI job that builds the docs using the docs.rs --cfg flag, and on a runner without installing cargo risczero or other custom tool. This job is intended to check that our docs will build on the docs.rs machines, and we don't get errors about broken docs build (e.g https://docs.rs/crate/cargo-risczero/0.21.0)
We've now merged docs.rs feature tags to the risc0-ethereum repo. It works for the subset of crates that we do publish to crates.io right now, with the blocker on the rest being a way to handle the fact that building the contracts crate requires Forge to be installed. risc0/risc0-ethereum#78
Hey @nategraf I made a little more progress here: feel free to take any part of it. the doc_auto_cfg thing requires you to split out the #[cfg(feature = ...)] into a separate line so that's what's going on in this PR to expose the export-syscalls feature
Hey @nategraf I made a little more progress here: feel free to take any part of it. the doc_auto_cfg thing requires you to split out the #[cfg(feature = ...)] into a separate line so that's what's going on in this PR to expose the export-syscalls feature
I'm actually not sure what the issue is here that you are referring to. I'm guessing something is not showing up that should?
@SchmErik and I discussed this and figured out where the confusion came from. This is ready for review / ready to merge when it looks good to you @flaub
A number of smaller docs updates from a quick pass over the
documentation.
Largest change is to include the `risc-groth16` README in the crate
documentation, thus bringing it under test in CI, and to drop the
verbose example of STARK to SNARK proving, which can now be accomplished
through the main APIs.
Are we still running into any issues with this? I see continued changes
#1880 got merged into this PR, and this PR started to fail because CI was running into two issues that stem from that PR. 1) I needed to run cargo rdme 2) I needed to update the test workflow since I removed the docker feature flag from risc0-groth16. (My intention was to wait until this PR landed to merge #1880, into main)
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR added Cargo metadata and crate-level attributes to get docs building with additional information on docs.rs. In particular, this will get feature-gates APIs (e.g. the
Provertrait) to show up on docs.rs.It also introduces a new CI job that builds the docs using the docs.rs
--cfgflag, and on a runner without installingcargo risczeroor other custom tool. This job is intended to check that our docs will build on the docs.rs machines, and we don't get errors about broken docs build (e.g https://docs.rs/crate/cargo-risczero/0.21.0)