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

Add notebooks to documentation #105

Merged
merged 14 commits into from
Mar 31, 2023
Merged

Add notebooks to documentation #105

merged 14 commits into from
Mar 31, 2023

Conversation

SarahAlidoost
Copy link
Contributor

@SarahAlidoost SarahAlidoost commented Mar 30, 2023

closes #100

This PR adds notebooks, and recipes to doc. It also reorganizes the doc. Preview the documentation here.

@SarahAlidoost SarahAlidoost marked this pull request as ready for review March 30, 2023 11:51
@SarahAlidoost SarahAlidoost requested a review from Peter9192 March 30, 2023 11:52
Copy link
Collaborator

@sverhoeven sverhoeven left a comment

Choose a reason for hiding this comment

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

All notebooks work except one, see inline suggestion.

The collapsed recipes at https://springtime--105.org.readthedocs.build/en/105/recipes/ look nice.

Why are we rendering the datasets notebooks, but downloading the example use case notebooks? Why not render them both? As you can add download link to rendered notebooks with https://github.com/danielfrg/mkdocs-jupyter#download-notebook-link

docs/example_usecases.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Peter9192 Peter9192 left a comment

Choose a reason for hiding this comment

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

Nice work, the package already looks so much richer now 🤩
But it also highlights a few other this that would be nice to address (probably in follow-up items):

  • Some R calls are very noisy. In rnpn we used --no-echo and captured stderr, we could consider doing this for all notebooks, perhaps as part of Standardize interface across data sources #92
  • It would be nice to add some explanation about the various datasets and their sources.

docs/example_usecases.md Outdated Show resolved Hide resolved
docs/recipes.md Show resolved Hide resolved
docs/notebooks/datasets_modis.ipynb Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
docs/recipes.md Show resolved Hide resolved
@SarahAlidoost
Copy link
Contributor Author

All notebooks work except one, see inline suggestion.

The collapsed recipes at https://springtime--105.org.readthedocs.build/en/105/recipes/ look nice.

Why are we rendering the datasets notebooks, but downloading the example use case notebooks? Why not render them both? As you can add download link to rendered notebooks with https://github.com/danielfrg/mkdocs-jupyter#download-notebook-link

Download links are added, see an example.

@SarahAlidoost
Copy link
Contributor Author

SarahAlidoost commented Mar 31, 2023

  • It would be nice to add some explanation about the various datasets and their sources.

@Peter9192 each notebook has a link to the data source. See an example. Are more explanations about datasets needed?

@SarahAlidoost SarahAlidoost merged commit 0ad5e57 into main Mar 31, 2023
@SarahAlidoost SarahAlidoost deleted the add_nbs_to_doc branch March 31, 2023 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add dataset notebooks to documentation
3 participants