From 291b5cbfc3d3f6f3d8ecbf326391c0ee74b79b5b Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Thu, 26 Mar 2026 22:29:38 +0100
Subject: [PATCH] DOC: Rename gallery README.txt files to GALLERY_HEADER.rst

GALLERY_HEADER.rst is a more telling name and avoids confusion with
regular READMEs. It's the name recommended by sphinx-gallery nowadays.
For details see
https://github.com/sphinx-gallery/sphinx-gallery/issues/1209

Using GALLERY_HEADER.rst is supported since sphinx-gallery 0.17
(released Jul 2024),so we need to bump the sphinx-gallery version.
---
 galleries/examples/{README.txt => GALLERY_HEADER.rst}           | 0
 galleries/examples/animation/{README.txt => GALLERY_HEADER.rst} | 0
 .../examples/axes_grid1/{README.txt => GALLERY_HEADER.rst}      | 0
 .../examples/axisartist/{README.txt => GALLERY_HEADER.rst}      | 0
 galleries/examples/color/{README.txt => GALLERY_HEADER.rst}     | 0
 .../examples/event_handling/{README.txt => GALLERY_HEADER.rst}  | 0
 .../{README.txt => GALLERY_HEADER.rst}                          | 0
 .../lines_bars_and_markers/{README.txt => GALLERY_HEADER.rst}   | 0
 galleries/examples/misc/{README.txt => GALLERY_HEADER.rst}      | 0
 galleries/examples/mplot3d/{README.txt => GALLERY_HEADER.rst}   | 0
 .../pie_and_polar_charts/{README.txt => GALLERY_HEADER.rst}     | 0
 galleries/examples/pyplots/{README.txt => GALLERY_HEADER.rst}   | 0
 galleries/examples/scales/{README.txt => GALLERY_HEADER.rst}    | 0
 .../shapes_and_collections/{README.txt => GALLERY_HEADER.rst}   | 0
 galleries/examples/showcase/{README.txt => GALLERY_HEADER.rst}  | 0
 .../examples/specialty_plots/{README.txt => GALLERY_HEADER.rst} | 0
 galleries/examples/spines/{README.txt => GALLERY_HEADER.rst}    | 0
 .../examples/statistics/{README.txt => GALLERY_HEADER.rst}      | 0
 .../examples/style_sheets/{README.txt => GALLERY_HEADER.rst}    | 0
 .../{README.txt => GALLERY_HEADER.rst}                          | 0
 .../{README.txt => GALLERY_HEADER.rst}                          | 0
 galleries/examples/ticks/{README.txt => GALLERY_HEADER.rst}     | 0
 galleries/examples/units/{README.txt => GALLERY_HEADER.rst}     | 0
 .../examples/user_interfaces/{README.txt => GALLERY_HEADER.rst} | 0
 galleries/examples/widgets/{README.txt => GALLERY_HEADER.rst}   | 0
 galleries/plot_types/3D/{README.rst => GALLERY_HEADER.rst}      | 0
 galleries/plot_types/{README.rst => GALLERY_HEADER.rst}         | 0
 galleries/plot_types/arrays/{README.rst => GALLERY_HEADER.rst}  | 0
 galleries/plot_types/basic/{README.rst => GALLERY_HEADER.rst}   | 0
 galleries/plot_types/stats/{README.rst => GALLERY_HEADER.rst}   | 0
 .../plot_types/unstructured/{README.rst => GALLERY_HEADER.rst}  | 0
 .../users_explain/animations/{README.txt => GALLERY_HEADER.rst} | 0
 .../users_explain/colors/{README.txt => GALLERY_HEADER.rst}     | 0
 galleries/users_explain/text/{README.txt => GALLERY_HEADER.rst} | 0
 pyproject.toml                                                  | 2 +-
 35 files changed, 1 insertion(+), 1 deletion(-)
 rename galleries/examples/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/animation/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/axes_grid1/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/axisartist/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/color/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/event_handling/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/images_contours_and_fields/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/lines_bars_and_markers/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/misc/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/mplot3d/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/pie_and_polar_charts/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/pyplots/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/scales/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/shapes_and_collections/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/showcase/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/specialty_plots/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/spines/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/statistics/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/style_sheets/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/subplots_axes_and_figures/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/text_labels_and_annotations/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/ticks/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/units/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/user_interfaces/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/examples/widgets/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/3D/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/arrays/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/basic/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/stats/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/plot_types/unstructured/{README.rst => GALLERY_HEADER.rst} (100%)
 rename galleries/users_explain/animations/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/users_explain/colors/{README.txt => GALLERY_HEADER.rst} (100%)
 rename galleries/users_explain/text/{README.txt => GALLERY_HEADER.rst} (100%)

diff --git a/galleries/examples/README.txt b/galleries/examples/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/README.txt
rename to galleries/examples/GALLERY_HEADER.rst
diff --git a/galleries/examples/animation/README.txt b/galleries/examples/animation/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/animation/README.txt
rename to galleries/examples/animation/GALLERY_HEADER.rst
diff --git a/galleries/examples/axes_grid1/README.txt b/galleries/examples/axes_grid1/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/axes_grid1/README.txt
rename to galleries/examples/axes_grid1/GALLERY_HEADER.rst
diff --git a/galleries/examples/axisartist/README.txt b/galleries/examples/axisartist/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/axisartist/README.txt
rename to galleries/examples/axisartist/GALLERY_HEADER.rst
diff --git a/galleries/examples/color/README.txt b/galleries/examples/color/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/color/README.txt
rename to galleries/examples/color/GALLERY_HEADER.rst
diff --git a/galleries/examples/event_handling/README.txt b/galleries/examples/event_handling/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/event_handling/README.txt
rename to galleries/examples/event_handling/GALLERY_HEADER.rst
diff --git a/galleries/examples/images_contours_and_fields/README.txt b/galleries/examples/images_contours_and_fields/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/images_contours_and_fields/README.txt
rename to galleries/examples/images_contours_and_fields/GALLERY_HEADER.rst
diff --git a/galleries/examples/lines_bars_and_markers/README.txt b/galleries/examples/lines_bars_and_markers/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/lines_bars_and_markers/README.txt
rename to galleries/examples/lines_bars_and_markers/GALLERY_HEADER.rst
diff --git a/galleries/examples/misc/README.txt b/galleries/examples/misc/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/misc/README.txt
rename to galleries/examples/misc/GALLERY_HEADER.rst
diff --git a/galleries/examples/mplot3d/README.txt b/galleries/examples/mplot3d/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/mplot3d/README.txt
rename to galleries/examples/mplot3d/GALLERY_HEADER.rst
diff --git a/galleries/examples/pie_and_polar_charts/README.txt b/galleries/examples/pie_and_polar_charts/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/pie_and_polar_charts/README.txt
rename to galleries/examples/pie_and_polar_charts/GALLERY_HEADER.rst
diff --git a/galleries/examples/pyplots/README.txt b/galleries/examples/pyplots/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/pyplots/README.txt
rename to galleries/examples/pyplots/GALLERY_HEADER.rst
diff --git a/galleries/examples/scales/README.txt b/galleries/examples/scales/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/scales/README.txt
rename to galleries/examples/scales/GALLERY_HEADER.rst
diff --git a/galleries/examples/shapes_and_collections/README.txt b/galleries/examples/shapes_and_collections/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/shapes_and_collections/README.txt
rename to galleries/examples/shapes_and_collections/GALLERY_HEADER.rst
diff --git a/galleries/examples/showcase/README.txt b/galleries/examples/showcase/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/showcase/README.txt
rename to galleries/examples/showcase/GALLERY_HEADER.rst
diff --git a/galleries/examples/specialty_plots/README.txt b/galleries/examples/specialty_plots/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/specialty_plots/README.txt
rename to galleries/examples/specialty_plots/GALLERY_HEADER.rst
diff --git a/galleries/examples/spines/README.txt b/galleries/examples/spines/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/spines/README.txt
rename to galleries/examples/spines/GALLERY_HEADER.rst
diff --git a/galleries/examples/statistics/README.txt b/galleries/examples/statistics/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/statistics/README.txt
rename to galleries/examples/statistics/GALLERY_HEADER.rst
diff --git a/galleries/examples/style_sheets/README.txt b/galleries/examples/style_sheets/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/style_sheets/README.txt
rename to galleries/examples/style_sheets/GALLERY_HEADER.rst
diff --git a/galleries/examples/subplots_axes_and_figures/README.txt b/galleries/examples/subplots_axes_and_figures/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/subplots_axes_and_figures/README.txt
rename to galleries/examples/subplots_axes_and_figures/GALLERY_HEADER.rst
diff --git a/galleries/examples/text_labels_and_annotations/README.txt b/galleries/examples/text_labels_and_annotations/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/text_labels_and_annotations/README.txt
rename to galleries/examples/text_labels_and_annotations/GALLERY_HEADER.rst
diff --git a/galleries/examples/ticks/README.txt b/galleries/examples/ticks/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/ticks/README.txt
rename to galleries/examples/ticks/GALLERY_HEADER.rst
diff --git a/galleries/examples/units/README.txt b/galleries/examples/units/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/units/README.txt
rename to galleries/examples/units/GALLERY_HEADER.rst
diff --git a/galleries/examples/user_interfaces/README.txt b/galleries/examples/user_interfaces/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/user_interfaces/README.txt
rename to galleries/examples/user_interfaces/GALLERY_HEADER.rst
diff --git a/galleries/examples/widgets/README.txt b/galleries/examples/widgets/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/examples/widgets/README.txt
rename to galleries/examples/widgets/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/3D/README.rst b/galleries/plot_types/3D/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/3D/README.rst
rename to galleries/plot_types/3D/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/README.rst b/galleries/plot_types/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/README.rst
rename to galleries/plot_types/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/arrays/README.rst b/galleries/plot_types/arrays/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/arrays/README.rst
rename to galleries/plot_types/arrays/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/basic/README.rst b/galleries/plot_types/basic/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/basic/README.rst
rename to galleries/plot_types/basic/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/stats/README.rst b/galleries/plot_types/stats/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/stats/README.rst
rename to galleries/plot_types/stats/GALLERY_HEADER.rst
diff --git a/galleries/plot_types/unstructured/README.rst b/galleries/plot_types/unstructured/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/plot_types/unstructured/README.rst
rename to galleries/plot_types/unstructured/GALLERY_HEADER.rst
diff --git a/galleries/users_explain/animations/README.txt b/galleries/users_explain/animations/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/users_explain/animations/README.txt
rename to galleries/users_explain/animations/GALLERY_HEADER.rst
diff --git a/galleries/users_explain/colors/README.txt b/galleries/users_explain/colors/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/users_explain/colors/README.txt
rename to galleries/users_explain/colors/GALLERY_HEADER.rst
diff --git a/galleries/users_explain/text/README.txt b/galleries/users_explain/text/GALLERY_HEADER.rst
similarity index 100%
rename from galleries/users_explain/text/README.txt
rename to galleries/users_explain/text/GALLERY_HEADER.rst
diff --git a/pyproject.toml b/pyproject.toml
index c3326bd6b88e..883836cd1e6e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -118,7 +118,7 @@ doc = [
     "sphinxcontrib-video>=0.2.1",
     "sphinx-copybutton",
     "sphinx-design",
-    "sphinx-gallery[parallel]>=0.12.0",
+    "sphinx-gallery[parallel]>=0.17.0",
     "sphinx-tags>=0.4.0",
 ]