adding gallery sorting #8975

choldgraf · 2017-08-01T18:49:11Z

Now that sphinx-gallery allows you to choose folder ordering within galleries, this is a PR that attempts to give this a shot. I figured it'd be cumbersome to choose a custom ordering for all of our folders, since really we just wanna make sure that a subset are at the top. So, this PR defines that subset, and then lists all the subsequent folders alphabetically.

This PR does:

Add gallery ordering (with a semi-arbitrary ordering chosen by me...lmk if you think it should be different)
Rename the tutorials folders from e.g., 01_introductory -> introductory since we don't need alphanumeric ordering anymore

Let's see how it looks in circle!

QuLogic

Looks like you might have missed renaming a few cross-references.

Can you also update the dependencies to require sphinx-gallery>=0.1.12, because otherwise the backreferences fail?

QuLogic · 2017-08-01T21:53:56Z

doc/conf.py

+                          '../tutorials/introductory',
+                          '../tutorials/intermediate',
+                          '../tutorials/advanced']
+for folder in glob('../examples/*') + glob('../tutorials/*'):


glob is not sorted.

choldgraf · 2017-08-03T02:22:09Z

ok I think I got all the cross references this time :-)

QuLogic · 2017-08-03T03:00:34Z

doc/conf.py

+explicit_order_folders = ['../examples/pyplots',
+                          '../examples/statistics',
+                          '../examples/color',
+                          '../examples/pylab_examples',


I think this just got removed with #8983 (might have to rebase to see it, though.)

whoah way to go @NelleV ! I didn't know we were so close to moving everything outta that folder. I'll rebase and see if it's gone now.

QuLogic · 2017-08-03T03:02:45Z

doc/conf.py

+                          '../examples/statistics',
+                          '../examples/color',
+                          '../examples/pylab_examples',
+                          '../examples/showcase',


Showcase should maybe be higher?

+1 for that...any others you'd like to see reordered?

Actually - I just realized that a better solution here might be to use the viewing data from google analytics to choose the ordering. That might be a kind of self-reinforcing kind of thing, but it's a good first start

QuLogic · 2017-08-03T03:04:28Z

doc/conf.py

+                          '../examples/color',
+                          '../examples/pylab_examples',
+                          '../examples/showcase',
+                          '../tutorials/introductory',


Where should I be looking to find this? In the gallery page, I don't think I see any tutorials after showcase?

The way SG handles this is there's just one list that defines the order priority. So folders inside of tutorials and examples won't be shown together or anything, this just defines the ordering. You can think of this as two separate lists, one for examples and one for tutorials.

story645 · 2017-08-03T14:03:46Z

Happy dance that there's now ordering, but I do wonder if there's some natural clustering of the categories aside from metrics. The list is:

Pyplot Examples
Statistics
Color
Pylab Examples
Showcase
Animation Examples
Matplotlib API
Axes Grid
Axis Artist
Event Handling
Front Page
Images, contours and fields
Lines, bars and markers
Miscellaneous Examples
mplot3d toolkit
Pie and polar charts
Our Favorite Recipes
Scales in Matplotlib
Shapes and collections
Specialty Plots
Style sheets
Subplots, axes and figures
Text, labels and annotations
Ticks and spines
Units in Matplotlib
Embedding matplotlib in graphical user interfaces
Userdemo
Widgets

I expect that some of these are probably are already being collapsed into each other, but I think some limit like n=10 or whatever a usability expert would suggest on categories (there are almost 30 in the list) could help make it all seem less overwhelming?

choldgraf · 2017-08-03T14:39:35Z

So I am definitely +1 on refactoring the examples (I actually think they should fall into a few sub-categories, since many of those examples aren't going to be of interest to non-dev users). But - that'll be complicated and will do things like breaking hard-links, so I'd prefer if we kept this PR focused on picking and implementing an order. WDYT?

story645 · 2017-08-03T15:49:18Z

I totally agree it's out scope for this PR, it just seems like the sort of thing someone is already working on concurrently and so figured I'd throw it out there.

As a first pass on ordering, I'm thinking roughly the following clusters:

Pyplot Examples (while this is most searched for, I debate promoting it to top since this isn't the recommended style)

Pylab Examples (though this is gone now?)
Statistics
Specialty Plots

Front Page
Showcase
Our Favorite Recipes
Miscellaneous Examples

Matplotlib API (though should maybe be moved right under/above pyplot examples)
Axes Grid
Axis Artist
Color
Images, contours and fields
Lines, bars and markers
Pie and polar charts
Shapes and collections
Scales in Matplotlib
Subplots, axes and figures
Style sheets
Text, labels and annotations
Ticks and spines
Units in Matplotlib
mplot3d toolkit

Animation Examples
Event Handling
Embedding matplotlib in graphical user interfaces
Widgets
Userdemo

WeatherGod · 2017-08-03T16:10:33Z

That first group just seems like a weird mishmash. I mean, what are "Specialty Plots" that aren't "Favorite Recipes". And why wouldn't our favorites be "Showcased"? And Statistics stands out like a sore thumb in that group. This is more an argument to possibly rename those sections and/or consolidate them further.

…

On Thu, Aug 3, 2017 at 11:49 AM, hannah ***@***.***> wrote: I totally agree it's out scope for this PR, it just seems like the sort of thing someone is already working on concurrently and so figured I'd throw it out there. As a first pass on ordering, I'm thinking roughly the following clusters: Pyplot Examples (while this is most searched for, I debate promoting it to top since this isn't the recommended style) Statistics Pylab Examples Front Page Showcase Miscellaneous Examples Our Favorite Recipes Specialty Plots Matplotlib API (though should maybe be moved right under/above pyplot examples) Animation Examples Axes Grid Axis Artist Color Images, contours and fields Lines, bars and markers Pie and polar charts Shapes and collections Scales in Matplotlib Subplots, axes and figures Style sheets Text, labels and annotations Ticks and spines Units in Matplotlib mplot3d toolkit Event Handling Embedding matplotlib in graphical user interfaces Widgets Userdemo — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub <#8975 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARy-Ix2uuvqycWGvjG_4iRl_J0p1NMXks5sUewFgaJpZM4OqI9a> .

story645 · 2017-08-03T16:41:13Z

Totally a mishmash. I just grabbed all the categories that just seem to be about displaying cool plots rather than showing off specific parts of the API 'cause they didn't seem to fit in anywhere else. I totally think they should be renamed and consolidated further.

choldgraf · 2017-08-03T16:41:45Z

Just to re-iterate, this PR isn't about renaming or combining example folders...just agreeing on an initial ordering, though I think it's a good idea to open a subsequent PR about combining etc. I think if that's a direction people are friendly to, it should happen before 2.1 is released, because this will break a lot of links.

to @story645's ordering, I think this is a good start! Agree we should shuffle things around a little bit. @WeatherGod do you have specific changes to the order that make more sense to you?

choldgraf · 2017-08-03T16:45:33Z

Here's a quick plot of the top ~20 folders inside of examples. I think we should assume pylab will be split up (which is a great idea IMO).

dstansby · 2017-08-03T19:11:36Z

@choldgraf pylab_examples is no more in the master branch

choldgraf · 2017-08-04T01:09:32Z

ok latest push no longer has pylab examples!

WeatherGod · 2017-08-04T13:41:23Z

I would put Statistics and Miscellaneous as the last two in the first group.

…

On Thu, Aug 3, 2017 at 9:09 PM, Chris Holdgraf ***@***.***> wrote: ok latest push no longer has pylab examples! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#8975 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AARy-JpP5BlUlylvVjfGfXu5ozAaKbPIks5sUm9OgaJpZM4OqI9a> .

tacaswell · 2017-08-04T14:29:50Z

👍 to getting the sorting in at all and defer bikeshedding of names, organization, etc to later work.

tacaswell added this to the 2.1 (next point release) milestone Aug 1, 2017

QuLogic reviewed Aug 1, 2017

View reviewed changes

QuLogic mentioned this pull request Aug 3, 2017

Updated downsampling #8776

Merged

6 tasks

QuLogic reviewed Aug 3, 2017

View reviewed changes

choldgraf force-pushed the examples_order branch from 6cae847 to 744e074 Compare August 4, 2017 01:08

choldgraf added 2 commits August 4, 2017 11:19

adding gallery sorting

a3c72bd

updating cross-refs and adding sphinx-gallery version dependency

b5227fe

choldgraf force-pushed the examples_order branch from 744e074 to 3de5bad Compare August 4, 2017 18:21

updating list

0cb00ea

choldgraf force-pushed the examples_order branch from 3de5bad to 0cb00ea Compare August 4, 2017 18:57

dstansby added the Documentation label Aug 4, 2017

NelleV merged commit 6582a9d into matplotlib:master Aug 4, 2017

choldgraf mentioned this pull request Sep 2, 2017

Folder ordering for the examples / tutorials page #8958

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding gallery sorting #8975

adding gallery sorting #8975

choldgraf commented Aug 1, 2017

QuLogic left a comment

QuLogic Aug 1, 2017

choldgraf commented Aug 3, 2017

QuLogic Aug 3, 2017 •

edited

Loading

choldgraf Aug 3, 2017

QuLogic Aug 3, 2017

choldgraf Aug 3, 2017

choldgraf Aug 3, 2017

QuLogic Aug 3, 2017 •

edited

Loading

choldgraf Aug 3, 2017

story645 commented Aug 3, 2017

choldgraf commented Aug 3, 2017

story645 commented Aug 3, 2017 •

edited

Loading

WeatherGod commented Aug 3, 2017 via email

story645 commented Aug 3, 2017

choldgraf commented Aug 3, 2017

choldgraf commented Aug 3, 2017 •

edited

Loading

dstansby commented Aug 3, 2017

choldgraf commented Aug 4, 2017

WeatherGod commented Aug 4, 2017 via email

tacaswell commented Aug 4, 2017

adding gallery sorting #8975

adding gallery sorting #8975

Conversation

choldgraf commented Aug 1, 2017

QuLogic left a comment

Choose a reason for hiding this comment

QuLogic Aug 1, 2017

Choose a reason for hiding this comment

choldgraf commented Aug 3, 2017

QuLogic Aug 3, 2017 • edited Loading

Choose a reason for hiding this comment

choldgraf Aug 3, 2017

Choose a reason for hiding this comment

QuLogic Aug 3, 2017

Choose a reason for hiding this comment

choldgraf Aug 3, 2017

Choose a reason for hiding this comment

choldgraf Aug 3, 2017

Choose a reason for hiding this comment

QuLogic Aug 3, 2017 • edited Loading

Choose a reason for hiding this comment

choldgraf Aug 3, 2017

Choose a reason for hiding this comment

story645 commented Aug 3, 2017

choldgraf commented Aug 3, 2017

story645 commented Aug 3, 2017 • edited Loading

WeatherGod commented Aug 3, 2017 via email

story645 commented Aug 3, 2017

choldgraf commented Aug 3, 2017

choldgraf commented Aug 3, 2017 • edited Loading

dstansby commented Aug 3, 2017

choldgraf commented Aug 4, 2017

WeatherGod commented Aug 4, 2017 via email

tacaswell commented Aug 4, 2017

QuLogic Aug 3, 2017 •

edited

Loading

QuLogic Aug 3, 2017 •

edited

Loading

story645 commented Aug 3, 2017 •

edited

Loading

choldgraf commented Aug 3, 2017 •

edited

Loading