-
Notifications
You must be signed in to change notification settings - Fork 339
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
Add docs.rs metadata to display features document prove APIs #1564
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Ignored Deployments
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
Related: #919 |
We've now merged docs.rs feature tags to the |
Hey @nategraf I made a little more progress here: feel free to take any part of it. the |
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? |
Co-authored-by: Frank Laub <flaub@risc0.com>
… victor/docs-rs-metadata
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 It should be good to go now. |
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 installingcargo 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)