-
-
Notifications
You must be signed in to change notification settings - Fork 7.9k
POC: add minigallery to plot types: bar #27512
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
Conversation
My 2cents: To me this looks a bit cluttered. Semi-OT: The overview page https://matplotlib.org/stable/plot_types/index is great. However, I don't see much benefit in the individual plot type pages like https://matplotlib.org/stable/plot_types/basic/plot.html. They contain
In sum, IMHO, there is no relevant content apart from the link. From a UX perspective, I would find it more straight forward to link from the overview page directly to the methods. This of course would mean, Sphinx gallery is not the right tool anymore. Instead, one would likely have to pre-render the plots and lay them out e.g. with Sphinx-design. The mini-galleries are useful, but I think they belong to the method (=all related content in one place). Note: One could put the creation of all the plots in a single example "Plot icons" (under examples), which would
|
I think the pages would flow better as graphic then code & I like the idea of one very stripped down example that shows just plotting one data set and very simple labeling. Mostly cause many of our examples have the opposite problem - doing too many things so it's hard to parse out the one thing.
Yeah, that's why I was thinking of adding the min-galleries, so they can act as a kind of TOC into the examples - but we can also achieve this with tags.
It's probably too hard to do & may not make any sense, but I kinda wish we could put each method on its own page. Both because some of the methods (like hist) have so much information, and because mini-galleries at the bottom of each of those pages would make sense. Also would not be opposed to (and I think this we can do) the gallery page having the pretty thumbnails, but the individual pages having the most basic w/ all the Matplotlib defaults, no special labeling, form. |
I think we can maybe do this using the plot directive + just use the sphinx gallery thumbnail directive + thumbnail parent div directive .... |
I also think this suggestion is too cluttered - "see bar" leads to the same gallery of related examples, so this would be redundant. I like the small example for each page. It's helpful in its own right, and links the method both explicitly, and in the code if people need the in-depth documentation. If we want the best of both worlds, maybe a link to |
Tagging this |
PR summary
Honestly not sure if adding mini galleries to the bottom would be helpful or feel cluttered (we can do basically the same thing w/ tags and tags allow for better curation) but trying it out here. Before this gets fully implemented I would try to fix the double listing in sphinx gallery. Also, I think thumbnail would have to go before code for this to be readable.
PR checklist