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

Auto generate docs #44

Open
wildintellect opened this issue Oct 12, 2022 · 2 comments
Open

Auto generate docs #44

wildintellect opened this issue Oct 12, 2022 · 2 comments
Labels
enhancement New feature or request

Comments

@wildintellect
Copy link

This library would greatly benefit from auto-generated python docs so that the full list of functions is browse-able in a webpage for users.
https://betterprogramming.pub/auto-documenting-a-python-project-using-sphinx-8878f9ddc6e9

@wildintellect wildintellect added the enhancement New feature or request label Oct 12, 2022
@rtapella
Copy link

rtapella commented Aug 1, 2023

Is that something different from https://api.maap-project.org/api/

(That article is paywalled)

@wildintellect
Copy link
Author

It's a little different but with overlapping purpose. The swagger page documents the API, but MAAP users don't directly use the API they use the maap-py python library. This ticket is to use Sphinx to generate python docs for the functions in maap-py that users use in their notebooks to interact with the API.

It need not be Sphinx there are other doc generators.

Example of a similar library https://nsidc.github.io/earthaccess/ which documents https://github.com/nsidc/earthaccess
Or the pystac-client https://pystac-client.readthedocs.io/en/stable/
The most classic example is Python itself https://docs.python.org/3/ (uses Sphinx)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants