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

Consider adding an example notebook gallery #56

Open
1 task
j08lue opened this issue May 9, 2023 · 4 comments
Open
1 task

Consider adding an example notebook gallery #56

j08lue opened this issue May 9, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@j08lue
Copy link
Contributor

j08lue commented May 9, 2023

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

  • Decided whether we should also add a visual gallery of our example notebooks
@j08lue j08lue added the enhancement New feature or request label May 9, 2023
@wildintellect
Copy link
Contributor

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
Copy link
Collaborator

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

@wildintellect
Copy link
Contributor

@j08lue
Copy link
Contributor Author

j08lue commented May 16, 2023

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:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants