docs: add docdb interface and utils usage to readthedocs - Githubissues

AllenNeuralDynamics / aind-data-access-api

Library to interface with AIND databases

MIT License

2 stars 0 forks source link

docs: add docdb interface and utils usage to readthedocs #62

Closed helen-m-lin closed 4 months ago

helen-m-lin commented 4 months ago

closes #49

Readthedocs updates:

Move Usage docs (for DocDBSSH and RDS clients) from readme to User Guide page
Add usage docs for the REST API client and Mongo Compass
Add DocumentDbSSHClient examples (show examples w/o projections first)
Enable automodule for aind_data_access_api.utils docs

A future ticket will address adding Contributing.rst; once done, remaining sections of the README can be removed.