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

Render Latex in docs #298

Open
plafer opened this issue Aug 16, 2024 · 2 comments
Open

Render Latex in docs #298

plafer opened this issue Aug 16, 2024 · 2 comments

Comments

@plafer
Copy link
Contributor

plafer commented Aug 16, 2024

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
Copy link
Collaborator

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
Copy link
Contributor Author

plafer commented Aug 20, 2024

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.

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

No branches or pull requests

2 participants