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

Notebook examples in documentation #341

Draft
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

ecomodeller
Copy link
Member

@ecomodeller ecomodeller commented Dec 16, 2023

Users shouldn't have to visit the Github repo to read notebooks.

Including them in the docs makes it possible to navigate to a specific section of a notebook, e.g. http://domain.com/examples/Hydrology_Vistula_Catchment/#statistics-aggregated-by-month

image

TODO:

  • Include relevant notebooks
  • Rendering of xarray repr_html not ideal
  • Consider to execute notebooks as part of the docs rendering

P.S. I didn't manage to reference the notebooks in the /notebooks folder, thus I added them as symbolic links to /docs/examples

@jsmariegaard
Copy link
Member

It's nice except those symbolic links are not working on windows which means that the documentation can no longer be build on windows🤔

@ecomodeller
Copy link
Member Author

Too bad, so how about copying the most relevant examples to the docs and keeping the notebooks folder as a repository of less polished examples?

@jsmariegaard
Copy link
Member

Yeah, or do some manual work (copy notebooks manually) when I once a while build the documentation locally? Let's decide next year 🎇

@ecomodeller
Copy link
Member Author

Notebooks will benefit from #378

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.

2 participants