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

add core notebooks as cards to example gallery #415

Merged
merged 2 commits into from
Sep 17, 2022

Conversation

OriolAbril
Copy link
Member

closes #379

@drbenvincent
Copy link
Contributor

Looks good. Although just a few thoughts:

  • Maybe the gallery view (icon size/alignment etc) can be the same for the core and regular examples. The gallery layout for the core notebooks seems better in that the images are bigger and they take up the full width of the page. That then also allows more space for text.
  • Do we really need the note? On the one hand it might answer some questions if someone can't see the core notebooks in the tags etc. But on the other hand, I'm not totally convinced this is really useful information for the majority of people and it kind of creates a visual barrier to getting to the funky gallery images

@OriolAbril
Copy link
Member Author

Maybe the gallery view (icon size/alignment etc) can be the same for the core and regular examples. The gallery layout for the core notebooks seems better in that the images are bigger and they take up the full width of the page. That then also allows more space for text.

that would be good but I don't know how to do it. The differences are because the core notebooks use grids and cards provided by sphinx-design whereas the regular ones use the style provided by sphinx gallery.

Do we really need the note? On the one hand it might answer some questions if someone can't see the core notebooks in the tags etc. But on the other hand, I'm not totally convinced this is really useful information for the majority of people and it kind of creates a visual barrier to getting to the funky gallery images

would moving the note below the core notebooks grid solve or partially solve this?

@drbenvincent
Copy link
Contributor

I think it would improve things. Maybe good to get someone else's view on it as well to see if we need it at all.

Just a random thought... could we get more consistency by placing all the notebooks in pymc-examples and just pointing to them from the main docs?

@OriolAbril
Copy link
Member Author

Just a random thought... could we get more consistency by placing all the notebooks in pymc-examples and just pointing to them from the main docs?

We decided to have a handful of notebooks in the pymc repo to make sure there are always some notebooks that are up to date with the latest release. pymc-examples is too big of a collection and with too little contributions and reviews available to keep the notebooks up to date.

From what I have seen, even with some nb update pushes around pymc releases and the like, at least ~50% of the notebooks are consistently 2+ years old.

examples/gallery.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@drbenvincent drbenvincent left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Would be great to figure out how to get the same kind of grid formatting for all the notebooks in the future.

@OriolAbril OriolAbril merged commit 32e132e into pymc-devs:main Sep 17, 2022
@OriolAbril OriolAbril deleted the core_notebooks branch September 17, 2022 12:31
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.

add notebooks in learn/core_notebooks to the main examples gallery
3 participants