-
Notifications
You must be signed in to change notification settings - Fork 0
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
Auto-generate Rust Documentation #27
Comments
whoever dives into this should look into latex rendering (e.g. via ktex_doc). If we are able to do it without too much friction, then I propose we use latex math in docstrings, and human-readable math for inline equations. If this is not possible, then we need to audit the whole repo and turn existing latex docs into human-readable equations. |
All solutions that I've found are variations of using the I don't think we need this now, but one interesting find is that you can also use Here's an example repo the renders latex docs: https://docs.rs/levenberg-marquardt/latest/levenberg_marquardt/ |
# Resolved Issues #27 # Description Adds scripts to render docs from code. For example: <img width="667" alt="image" src="https://github.com/delvtech/hyperdrive-rs/assets/153468/641727b8-7b57-43ac-80f0-aabe51d0cd49">
We should publish the auto-generated rust docs from the Rust SDK. We could also publish a docs portal for the Rust SDK and other SDKs.
The text was updated successfully, but these errors were encountered: