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 docs summarizing which iNaturalist API endpoints pyinaturalist implements #64

Closed
JWCook opened this issue Oct 7, 2020 · 0 comments · Fixed by #63 or #65
Closed

Add docs summarizing which iNaturalist API endpoints pyinaturalist implements #64

JWCook opened this issue Oct 7, 2020 · 0 comments · Fixed by #63 or #65
Labels
docs Documentation-related issues
Milestone

Comments

@JWCook
Copy link
Member

JWCook commented Oct 7, 2020

It would be useful to show in a concise manner which API endpoints pyinaturalist implements, so a new user can more easily get an idea of the features offered. For that purpose, I'd like to add a table listing all iNaturalist API endpoints, indicating which ones have been implemented in pyinaturalist.

Also, now that the list of API functions has grown, as well as the amount of documentation per function, the docs for the node_api and rest_api modules are now quite long. I'd like to add function summary sections at the top of each of these modules. There are a number of Sphinx extensions that could accomplish this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
1 participant