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

Documentation #23

Open
davidlday opened this issue Aug 22, 2021 · 1 comment
Open

Documentation #23

davidlday opened this issue Aug 22, 2021 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@davidlday
Copy link
Contributor

Provide better documentation.
@davidlday davidlday added enhancement New feature or request help wanted Extra attention is needed labels Aug 22, 2021
@yvlcmb
Copy link
Contributor

yvlcmb commented Aug 24, 2022

Sounds like a job for Sphinx! You already have some great docstings set up, so with a bit of configuration to the repo, Sphinx could use those to generate the documentation for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@davidlday @yvlcmb