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

Docs/sphinx #69

Merged
merged 26 commits into from
May 14, 2021
Merged

Docs/sphinx #69

merged 26 commits into from
May 14, 2021

Conversation

rdnfn
Copy link
Member

@rdnfn rdnfn commented May 13, 2021

Description: This (draft) PR improves the documentation for GeoGraph.

It adds the already existing jupyter notebook tutorials as pages to our readthedocs sphinx documentation. See the docs version of this branch at the link here. Minor adaptions have been made to the notebooks, mainly so their headings are at the correct level.

TODOs before merging:
In each of the notebooks:

  • Hide irrelevant code blocks by adding relevant data to metadata (see here how to do this)
  • Add note/button close to the top that launches that particular notebook in binder
  • Add explanation about how to get the relevant example data when not using the binder (e.g. by adding the download command with dropbox)
  • Address the points raised in Issue Docs: improve description of tutorial notebooks #67
  • Viewer notebooks: add note that there would be an interactive viewer that is not shown (maybe add GIF)

Other things todo:

  • Update GitHub project description (and remove unnecessary reference to team challenge)
  • Update main readme to better reflect the functionality.

Feel free to commit any changes to this branch 🚀

@rdnfn rdnfn added the kind: documentation Improvements or additions to documentation label May 13, 2021
@rdnfn rdnfn requested a review from Croydon-Brixton May 13, 2021 09:07
@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@Croydon-Brixton
Copy link
Collaborator

Croydon-Brixton commented May 13, 2021

Thanks for starting this draft pull request, Arduin!

I started by adding the ESA CCI Legend to the interactive viewer (i.e. now it shows the actual land cover class label (e.g. cropland, rainfed) rather than just the integer code (10)).
More changes to come.

For this point

Add note/button close to the top that launches that particular notebook in binder

this explanation here might be helpful.

@rdnfn rdnfn marked this pull request as ready for review May 14, 2021 10:28
@rdnfn
Copy link
Member Author

rdnfn commented May 14, 2021

This is not quite completed yet but worthwhile to merge already

Copy link
Collaborator

@Croydon-Brixton Croydon-Brixton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, since it's only doc changes it should not include breaking changes. I tested all of my changes locally to confim they don't break

@rdnfn rdnfn merged commit 7ac51e5 into main May 14, 2021
@rdnfn rdnfn deleted the docs/sphinx branch May 14, 2021 10:48
@rdnfn rdnfn restored the docs/sphinx branch May 14, 2021 10:48
@rdnfn rdnfn deleted the docs/sphinx branch May 14, 2021 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants