search

SnowEx / snowexsql

A project to access the SnowEx database holding data from the NASA SnowEx campaign
https://snowexsql.readthedocs.io/en/latest/readme.html
GNU General Public License v3.0
23 stars 6 forks source link

feat: Add jupyterbook configuration #92

Closed lsetiawan closed 1 month ago

lsetiawan commented 1 month ago

This PR adds jupyterbook configuration setup

lsetiawan commented 1 month ago

Preview of Jupyterbook can be found at https://snowexsql--92.org.readthedocs.build/en/92/ ... hopefully I did this right.

jomey commented 1 month ago

@micah-prime, @micahjohnson150 - How do you feel about using JupyterBook as the documentation framework. It's basically built on Sphinx and feels easier to contribute for newcomers.

Thoughts?

micahjohnson150 commented 1 month ago

Looks good to me. Looks like the gallery thumbnails dont get rendered anymore. Is there a way to make the gallery still be dope little thumbnails? Here is what it was beforehand.

Screenshot 2024-07-25 at 9 35 16 AM

lsetiawan commented 1 month ago

@micahjohnson150 Unfortunately this is a feature that is missing from jupyter-book. See https://github.com/jupyter-book/jupyter-book/issues/1785 and https://github.com/jupyter-book/jupyter-book/issues/2036.

lsetiawan commented 1 month ago

One additional comment about this:

Although the gallery is nice, I think that organizing the notebooks by learning paths like how xarray tutorials jupyter book is structured would be better to allow different users to quickly navigate to the notebook they need: https://tutorial.xarray.dev/overview/fundamental-path/README.html

jomey commented 1 month ago

Thanks for pointing us to the Xarray examples. Maybe this could be a Hackweek project task to organize our growing number of example tutorials :smile:

JessicaS11 commented 1 month ago

Unfortunately this is a feature that is missing from jupyter-book. See https://github.com/jupyter-book/jupyter-book/issues/1785 and https://github.com/jupyter-book/jupyter-book/issues/2036.

Not sure if this helps/is what you're after, but I did recently add a gallery capability (with user contributions via a .yml instead of the underlying panels) to the IS2 book.