Open-EO / Open-EO/openeo-python-client
Documentation as notebooks and vice versa
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 217
- Forks
- 56
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 2
Description
Interesting observation from Google Earth Engine community docs:
e.g. https://developers.google.com/earth-engine/tutorials/community/intro-to-python-api-guiattard is written as a notebook (https://github.com/google/earthengine-community/blob/master/tutorials/intro-to-python-api-guiattard/index.ipynb), but seamlessly integrated in their documentation tree
It could be useful to adapt that approach as well for a part of the openEO python lib documentation (e.g. quick start or tutorials):
- makes it easy to check that snippets are valid (could be even part of integration test suite)
- allows user to start experimenting directly from docs downloaded as notebook
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Google Earth Engine documentation and its tutorials/intro-to-python-api-guiattard/index.ipynb example. Then inspect the openEO Python client’s quick-start and tutorial documentation to determine a workable notebook-to-docs approach and how snippet validation or integration tests could fit; done means a concrete, tested workflow is defined.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- jupyter-notebook, python
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100