Skip to content

Commit fe53160

Browse files
committed
MNT: re-organize galleries under one subdir [ci doc]
1 parent 4348a33 commit fe53160

File tree

633 files changed

+122
-122
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

633 files changed

+122
-122
lines changed

.flake8

+38-38
Original file line numberDiff line numberDiff line change
@@ -55,43 +55,43 @@ per-file-ignores =
5555
lib/pylab.py: F401, F403
5656

5757
doc/conf.py: E402
58-
tutorials/advanced/path_tutorial.py: E402
59-
tutorials/advanced/patheffects_guide.py: E402
60-
tutorials/advanced/transforms_tutorial.py: E402, E501
61-
tutorials/colors/colormaps.py: E501
62-
tutorials/colors/colors.py: E402
63-
tutorials/intermediate/artists.py: E402
64-
tutorials/intermediate/constrainedlayout_guide.py: E402
65-
tutorials/intermediate/legend_guide.py: E402
66-
tutorials/intermediate/tight_layout_guide.py: E402
67-
tutorials/introductory/animation_tutorial.py: E501
68-
tutorials/introductory/images.py: E501
69-
tutorials/introductory/pyplot.py: E402, E501
70-
tutorials/text/annotations.py: E402, E501
71-
tutorials/text/mathtext.py: E501
72-
tutorials/text/text_intro.py: E402
73-
tutorials/text/text_props.py: E501
58+
galleries/tutorials/advanced/path_tutorial.py: E402
59+
galleries/tutorials/advanced/patheffects_guide.py: E402
60+
galleries/tutorials/advanced/transforms_tutorial.py: E402, E501
61+
galleries/tutorials/colors/colormaps.py: E501
62+
galleries/tutorials/colors/colors.py: E402
63+
galleries/tutorials/intermediate/artists.py: E402
64+
galleries/tutorials/intermediate/constrainedlayout_guide.py: E402
65+
galleries/tutorials/intermediate/legend_guide.py: E402
66+
galleries/tutorials/intermediate/tight_layout_guide.py: E402
67+
galleries/tutorials/introductory/animation_tutorial.py: E501
68+
galleries/tutorials/introductory/images.py: E501
69+
galleries/tutorials/introductory/pyplot.py: E402, E501
70+
galleries/tutorials/text/annotations.py: E402, E501
71+
galleries/tutorials/text/mathtext.py: E501
72+
galleries/tutorials/text/text_intro.py: E402
73+
galleries/tutorials/text/text_props.py: E501
7474

75-
examples/animation/frame_grabbing_sgskip.py: E402
76-
examples/images_contours_and_fields/tricontour_demo.py: E201
77-
examples/images_contours_and_fields/tripcolor_demo.py: E201
78-
examples/images_contours_and_fields/triplot_demo.py: E201
79-
examples/lines_bars_and_markers/marker_reference.py: E402
80-
examples/misc/print_stdout_sgskip.py: E402
81-
examples/misc/table_demo.py: E201
82-
examples/style_sheets/bmh.py: E501
83-
examples/subplots_axes_and_figures/demo_constrained_layout.py: E402
84-
examples/text_labels_and_annotations/custom_legends.py: E402
85-
examples/ticks/date_concise_formatter.py: E402
86-
examples/ticks/date_formatters_locators.py: F401
87-
examples/user_interfaces/embedding_in_gtk3_panzoom_sgskip.py: E402
88-
examples/user_interfaces/embedding_in_gtk3_sgskip.py: E402
89-
examples/user_interfaces/embedding_in_gtk4_panzoom_sgskip.py: E402
90-
examples/user_interfaces/embedding_in_gtk4_sgskip.py: E402
91-
examples/user_interfaces/gtk3_spreadsheet_sgskip.py: E402
92-
examples/user_interfaces/gtk4_spreadsheet_sgskip.py: E402
93-
examples/user_interfaces/mpl_with_glade3_sgskip.py: E402
94-
examples/user_interfaces/pylab_with_gtk3_sgskip.py: E402
95-
examples/user_interfaces/pylab_with_gtk4_sgskip.py: E402
96-
examples/userdemo/pgf_preamble_sgskip.py: E402
75+
galleries/examples/animation/frame_grabbing_sgskip.py: E402
76+
galleries/examples/images_contours_and_fields/tricontour_demo.py: E201
77+
galleries/examples/images_contours_and_fields/tripcolor_demo.py: E201
78+
galleries/examples/images_contours_and_fields/triplot_demo.py: E201
79+
galleries/examples/lines_bars_and_markers/marker_reference.py: E402
80+
galleries/examples/misc/print_stdout_sgskip.py: E402
81+
galleries/examples/misc/table_demo.py: E201
82+
galleries/examples/style_sheets/bmh.py: E501
83+
galleries/examples/subplots_axes_and_figures/demo_constrained_layout.py: E402
84+
galleries/examples/text_labels_and_annotations/custom_legends.py: E402
85+
galleries/examples/ticks/date_concise_formatter.py: E402
86+
galleries/examples/ticks/date_formatters_locators.py: F401
87+
galleries/examples/user_interfaces/embedding_in_gtk3_panzoom_sgskip.py: E402
88+
galleries/examples/user_interfaces/embedding_in_gtk3_sgskip.py: E402
89+
galleries/examples/user_interfaces/embedding_in_gtk4_panzoom_sgskip.py: E402
90+
galleries/examples/user_interfaces/embedding_in_gtk4_sgskip.py: E402
91+
galleries/examples/user_interfaces/gtk3_spreadsheet_sgskip.py: E402
92+
galleries/examples/user_interfaces/gtk4_spreadsheet_sgskip.py: E402
93+
galleries/examples/user_interfaces/mpl_with_glade3_sgskip.py: E402
94+
galleries/examples/user_interfaces/pylab_with_gtk3_sgskip.py: E402
95+
galleries/examples/user_interfaces/pylab_with_gtk4_sgskip.py: E402
96+
galleries/examples/userdemo/pgf_preamble_sgskip.py: E402
9797
force-check = True

.github/workflows/tests.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ on:
1515
paths-ignore:
1616
# Skip running tests if changes are only in documentation directories
1717
- 'doc/**'
18-
- 'examples/**'
19-
- 'plot_types/**'
20-
- 'tutorials/**'
18+
- 'galleries/examples/**'
19+
- 'galleries/plot_types/**'
20+
- 'galleries/tutorials/**'
2121
schedule:
2222
# 5:47 UTC on Saturdays
2323
- cron: "47 5 * * 6"

.gitignore

+8-10
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,8 @@ Thumbs.db
5656

5757
# Things specific to this project #
5858
###################################
59-
tutorials/intermediate/CL01.png
60-
tutorials/intermediate/CL02.png
59+
galleries/tutorials/intermediate/CL01.png
60+
galleries/tutorials/intermediate/CL02.png
6161

6262
# Documentation generated files #
6363
#################################
@@ -72,14 +72,12 @@ doc/plot_types
7272
doc/pyplots/tex_demo.png
7373
doc/tutorials
7474
lib/dateutil
75-
examples/*/*.bmp
76-
examples/*/*.eps
77-
examples/*/*.pdf
78-
examples/*/*.png
79-
examples/*/*.svg
80-
examples/*/*.svgz
81-
examples/tests/*
82-
!examples/tests/backend_driver_sgskip.py
75+
galleries/examples/*/*.bmp
76+
galleries/examples/*/*.eps
77+
galleries/examples/*/*.pdf
78+
galleries/examples/*/*.png
79+
galleries/examples/*/*.svg
80+
galleries/examples/*/*.svgz
8381
result_images
8482
doc/_static/constrained_layout*.png
8583
doc/.mpl_skip_subdirs.yaml

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ repos:
4747
hooks:
4848
- id: isort
4949
name: isort (python)
50-
files: ^tutorials/|^examples/|^plot_types/
50+
files: ^galleries/tutorials/|^galleries/examples/|^galleries/plot_types/

doc/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -216,8 +216,8 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
216216
gallery_dirs = [f'{ed}' for ed in ['gallery', 'tutorials', 'plot_types']
217217
if f'{ed}/*' not in skip_subdirs]
218218

219-
example_dirs = [f'../{gd}'.replace('gallery', 'examples') for gd in
220-
gallery_dirs]
219+
example_dirs = [f'../galleries/{gd}'.replace('gallery', 'examples')
220+
for gd in gallery_dirs]
221221

222222
sphinx_gallery_conf = {
223223
'backreferences_dir': Path('api') / Path('_as_gen'),

doc/devel/documenting_mpl.rst

+9-7

doc/sphinxext/gallery_order.py

+23-23
Original file line numberDiff line numberDiff line change
@@ -11,37 +11,37 @@
1111
UNSORTED = "unsorted"
1212

1313
examples_order = [
14-
'../examples/lines_bars_and_markers',
15-
'../examples/images_contours_and_fields',
16-
'../examples/subplots_axes_and_figures',
17-
'../examples/statistics',
18-
'../examples/pie_and_polar_charts',
19-
'../examples/text_labels_and_annotations',
20-
'../examples/color',
21-
'../examples/shapes_and_collections',
22-
'../examples/style_sheets',
23-
'../examples/pyplots',
24-
'../examples/axes_grid1',
25-
'../examples/axisartist',
26-
'../examples/showcase',
14+
'../galleries/examples/lines_bars_and_markers',
15+
'../galleries/examples/images_contours_and_fields',
16+
'../galleries/examples/subplots_axes_and_figures',
17+
'../galleries/examples/statistics',
18+
'../galleries/examples/pie_and_polar_charts',
19+
'../galleries/examples/text_labels_and_annotations',
20+
'../galleries/examples/color',
21+
'../galleries/examples/shapes_and_collections',
22+
'../galleries/examples/style_sheets',
23+
'../galleries/examples/pyplots',
24+
'../galleries/examples/axes_grid1',
25+
'../galleries/examples/axisartist',
26+
'../galleries/examples/showcase',
2727
UNSORTED,
28-
'../examples/userdemo',
28+
'../galleries/examples/userdemo',
2929
]
3030

3131
tutorials_order = [
32-
'../tutorials/introductory',
33-
'../tutorials/intermediate',
34-
'../tutorials/advanced',
32+
'../galleries/tutorials/introductory',
33+
'../galleries/tutorials/intermediate',
34+
'../galleries/tutorials/advanced',
3535
UNSORTED,
36-
'../tutorials/provisional'
36+
'../galleries/tutorials/provisional'
3737
]
3838

3939
plot_types_order = [
40-
'../plot_types/basic',
41-
'../plot_types/arrays',
42-
'../plot_types/stats',
43-
'../plot_types/unstructured',
44-
'../plot_types/3D',
40+
'../galleries/plot_types/basic',
41+
'../galleries/plot_types/arrays',
42+
'../galleries/plot_types/stats',
43+
'../galleries/plot_types/unstructured',
44+
'../galleries/plot_types/3D',
4545
UNSORTED
4646
]
4747

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)