STY: Combine declarations of example directories

tonysyu · tonysyu · commit 804b94c154c4 · 2013-04-18T21:00:06.000-05:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -104,21 +104,27 @@
 
 plot_formats = [('png', 80), ('hires.png', 200), ('pdf', 50)]
 
-# Subdirectories in 'examples/' directory of package
-mpl_example_sections = ('lines_bars_and_markers',
-                        'shapes_and_collections',
-                        'statistics',
-                        'images_contours_and_fields',
-                        'pie_and_polar_charts',
-                        'color',
-                        'text_labels_and_annotations',
-                        'ticks_and_spines',
-                        'subplots_axes_and_figures',
-                        'specialty_plots',
-                        'showcase',
-                        'api', 'pylab_examples',
-                        'mplot3d', 'axes_grid',
-                        'units', 'widgets')
+# Subdirectories in 'examples/' directory of package and titles for gallery
+# TODO: Change to OrderedDict when Matplotlib drops support for Python < 2.7
+mpl_example_sections = (
+    ('lines_bars_and_markers', 'Lines, bars, and markers'),
+    ('shapes_and_collections', 'Shapes and collections'),
+    ('statistics', 'Statistical plots'),
+    ('images_contours_and_fields', 'Images, contours, and fields'),
+    ('pie_and_polar_charts', 'Pie and polar charts'),
+    ('color', 'Color'),
+    ('text_labels_and_annotations', 'Text, labels, and annotations'),
+    ('ticks_and_spines', 'Ticks and spines'),
+    ('subplots_axes_and_figures', 'Subplots, axes, and figures'),
+    ('specialty_plots', 'Specialty plots'),
+    ('showcase', 'Showcase'),
+    ('api', 'API'),
+    ('pylab_examples', 'pylab examples'),
+    ('mplot3d', 'mplot3d toolkit'),
+    ('axes_grid', 'axes_grid toolkit'),
+    ('units', 'units'),
+    ('widgets', 'widgets'),
+    )
 
 
 # Github extension
diff --git a/doc/sphinxext/gen_gallery.py b/doc/sphinxext/gen_gallery.py
@@ -11,20 +11,6 @@
 
 exclude_example_sections = ['units']
 multiimage = re.compile('(.*?)(_\d\d){1,2}')
-custom_titles = {'pylab_examples' : 'pylab examples',
-                 'lines_bars_and_markers': 'Lines, bars, and markers',
-                 'shapes_and_collections': 'Shapes and collections',
-                 'statistics': 'Statistical plots',
-                 'images_contours_and_fields': 'Images, contours, and fields',
-                 'pie_and_polar_charts': 'Pie and polar charts',
-                 'text_labels_and_annotations': 'Text, labels, and annotations',
-                 'ticks_and_spines': 'Ticks and spines',
-                 'subplots_axes_and_figures': 'Subplots, axes, and figures',
-                 'specialty_plots': 'Specialty plots',
-                 'showcase': 'Showcase',
-                 'color': 'Color',
-                 'api': 'API',
-                 }
 
 # generate a thumbnail gallery of examples
 gallery_template = """\
@@ -79,8 +65,9 @@ def gen_gallery(app, doctree):
     rootdir = 'plot_directive/mpl_examples'
 
     example_sections = list(app.builder.config.mpl_example_sections)
-    for section in exclude_example_sections:
-        example_sections.remove(section)
+    for i, (subdir, title) in enumerate(example_sections):
+        if subdir in exclude_example_sections:
+            example_sections.pop(i)
 
     # images we want to skip for the gallery because they are an unusual
     # size that doesn't layout well in a table, or because they may be
@@ -96,8 +83,7 @@ def gen_gallery(app, doctree):
     rows = []
     toc_rows = []
 
-    for subdir in example_sections:
-        title = custom_titles.get(subdir, subdir)
+    for subdir, title in example_sections:
         rows.append(header_template.format(title=title, section=subdir))
         toc_rows.append(toc_template.format(title=title, section=subdir))
 
diff --git a/doc/sphinxext/gen_rst.py b/doc/sphinxext/gen_rst.py
@@ -33,9 +33,10 @@ def generate_example_rst(app):
         os.makedirs(exampledir)
 
     example_sections = list(app.builder.config.mpl_example_sections)
-    for section in exclude_example_sections:
-        example_sections.remove(section)
-
+    for i, (subdir, title) in enumerate(example_sections):
+        if subdir in exclude_example_sections:
+            example_sections.pop(i)
+    example_subdirs, titles = zip(*example_sections)
 
     datad = {}
     for root, subFolders, files in os.walk(rootdir):
@@ -122,7 +123,7 @@ def generate_example_rst(app):
 
             fhsubdirIndex.write('    %s <%s>\n'%(os.path.basename(basename),rstfile))
 
-            do_plot = (subdir in example_sections
+            do_plot = (subdir in example_subdirs
                        and not noplot_regex.search(contents))
             if not do_plot:
                 fhstatic = io.open(outputfile, 'w', encoding='utf-8')
