search

facebook / winterfell

A STARK prover and verifier for arbitrary computations
MIT License
795 stars 180 forks source link

Render Latex in docs #298

Open plafer opened 3 months ago

plafer commented 3 months ago

This example repo shows how to render Latex in docs.

This is now needed with LogUp-GKR, where our docs use a fair amount of Latex.

irakliyk commented 3 months ago

I think this is already supported (e.g., see here). To view docs with formulas rendered correctly locally, you should be able to run the following command:

RUSTDOCFLAGS="--html-in-header .cargo/katex-header.html" cargo doc --manifest-path sumcheck/Cargo.toml --open --no-deps

Or is there anything else missing?

plafer commented 2 months ago

Oh I would just run cargo doc --open and (obviously) see the unrendered latex, and I didn't realize that you had solved the problem already.

I would add a section to the README which documents how to generate the docs locally properly.