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

Add Full Documentation #6

Merged
merged 16 commits into from
Jul 24, 2024
Merged

Add Full Documentation #6

merged 16 commits into from
Jul 24, 2024

Conversation

contagon
Copy link
Collaborator

Documented entire package! Tried to add sufficient examples and mathematical background to make it worthwhile. To build with latex support, simply run

RUSTDOCFLAGS="--html-in-header assets/katex-header.html" cargo doc --open --no-deps

@taylorpool would you mind giving this a look? If you wouldn't mind perusing, it'd be nice to have some feedback on where some holes might be in the docs.

@contagon contagon merged commit 68c13cf into master Jul 24, 2024
1 check passed
@contagon contagon deleted the docs branch July 26, 2024 12:54
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

Successfully merging this pull request may close these issues.

1 participant