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.

Sign up for GitHub

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

Jump to bottom

TODO: setup documentation generation #5

Open
ksaur opened this issue Aug 30, 2024 · 1 comment
Open

TODO: setup documentation generation #5

ksaur opened this issue Aug 30, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed TODO Something we haven't had time for yet but want to do

Comments

@ksaur
Copy link
Contributor

ksaur commented Aug 30, 2024

As we slowly add the documentation, we also should setup auto doc generation. The pipeline code is in place. This particular setup uses sphinx but there are many options we could chose from.
@ksaur ksaur added TODO Something we haven't had time for yet but want to do documentation Improvements or additions to documentation help wanted Extra attention is needed labels Aug 30, 2024
@bpkroth
Copy link
Contributor

bpkroth commented Sep 19, 2024

This should probably wait until after #96

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed TODO Something we haven't had time for yet but want to do
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ksaur @bpkroth