search

NASA-IMPACT / veda-docs

Documentation for the VEDA Project
https://nasa-impact.github.io/veda-docs
Apache License 2.0
7 stars 7 forks source link

Consider adding an example notebook gallery #56

Open j08lue opened 1 year ago

j08lue commented 1 year ago

The docs for the scientific compute community at COSIMA - the COSIMA Cookbook - is quite nicely laid out and has the same goal as our docs: to introduce standard practice with data discovery and analysis tooling.

A feature @wildintellect noticed as nice is the example notebook gallery: https://cosima-recipes.readthedocs.io/en/latest/documented_examples.html

image

Acceptance criteria

wildintellect commented 1 year ago

I'll note, what this is missing is subsections to organize when too many examples exist. Have not looked at the nbgallery tool yet to see how hard that would be.

jsignell commented 1 year ago

I think a visual gallery is nice. Does quarto have a mechanism for supporting thins?

wildintellect commented 1 year ago

It would seem yes, https://quarto.org/docs/websites/website-listings.html

j08lue commented 1 year ago

There are some considerations regarding merging VEDA and MAAP in terms of support - and perhaps also docs then?

MAAP is currently using Sphinx and VEDA Quarto. If we only keep one of the two, we could focus our effort on that. Maybe we can have a quick discussion / call on the question of whether / when to merge docs? I started a ticket here: