modelskill icon indicating copy to clipboard operation
modelskill copied to clipboard

Notebook examples in documentation

Open ecomodeller opened this issue 2 years ago • 4 comments

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

ecomodeller avatar Dec 16 '23 08:12 ecomodeller

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

jsmariegaard avatar Dec 21 '23 22:12 jsmariegaard

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?

ecomodeller avatar Dec 22 '23 10:12 ecomodeller

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

jsmariegaard avatar Dec 22 '23 10:12 jsmariegaard

Notebooks will benefit from #378

ecomodeller avatar Feb 12 '24 21:02 ecomodeller