Open-EO / openeo-python-client

Python client API for OpenEO
https://open-eo.github.io/openeo-python-client/
Apache License 2.0
155 stars 41 forks source link

Documentation as notebooks and vice versa #195

Open soxofaan opened 3 years ago

soxofaan commented 3 years ago

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):

soxofaan commented 3 years ago

This seems to be a sphinx plugin that supports this: https://nbsphinx.readthedocs.io/