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

Auto-generate Rust Documentation #27

Closed
jalextowle opened this issue Apr 16, 2024 · 3 comments · Fixed by #157
Closed

Auto-generate Rust Documentation #27

jalextowle opened this issue Apr 16, 2024 · 3 comments · Fixed by #157
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jalextowle
Copy link
Contributor

jalextowle commented Apr 16, 2024

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.

@dpaiton
Copy link
Member

dpaiton commented Jun 27, 2024

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.

@dpaiton
Copy link
Member

dpaiton commented Jun 30, 2024

All solutions that I've found are variations of using the --html-in-header flag to inject html that runs katex javascript at runtime.

I don't think we need this now, but one interesting find is that you can also use --html-before-content to define global LaTeX equation macros that then can be used throughout.

Here's an example repo the renders latex docs: https://docs.rs/levenberg-marquardt/latest/levenberg_marquardt/

@dpaiton
Copy link
Member

dpaiton commented Jun 30, 2024

ok, I think I got a handle on it. I'll take lead on this
image

@dpaiton dpaiton self-assigned this Jun 30, 2024
@dpaiton dpaiton added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 30, 2024
@dpaiton dpaiton linked a pull request Jun 30, 2024 that will close this issue
dpaiton added a commit that referenced this issue Jul 1, 2024
# 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">
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants