Skip to content

Notebook examples in documentation#341

Merged
ecomodeller merged 7 commits intomainfrom
docs-examples-notebooks
Dec 13, 2024
Merged

Notebook examples in documentation#341
ecomodeller merged 7 commits intomainfrom
docs-examples-notebooks

Conversation

@ecomodeller
Copy link
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
Member Author

Notebooks will benefit from #378

@ecomodeller ecomodeller merged commit 356635e into main Dec 13, 2024
@ecomodeller ecomodeller deleted the docs-examples-notebooks branch September 25, 2025 07:56
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