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

Create automated API documentation #16

Open
jsolly opened this issue Aug 25, 2023 · 0 comments
Open

Create automated API documentation #16

jsolly opened this issue Aug 25, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@jsolly
Copy link

jsolly commented Aug 25, 2023

Context

It would be useful if there was some kind of auto-documentation a developer could visit to quickly see all the classes, functions, and what they do.

Eventually, we'll want handwritten examples, but this would be a good first step.

Thoughts

I like when projects have a 'readthedocs' link. Perhaps we can do that.

This documentation link should be able to be accessed from the GitHub readme and PyPi.

@jsolly jsolly added the documentation Improvements or additions to documentation label Aug 25, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant