Dec 16, 2025 · Dec 15, 2025
diff --git a/doc/conf.py b/doc/conf.py
 else:
    sg_matplotlib_animations = True

 # The following import is only necessary to monkey patch the signature later on
 from sphinx_gallery import gen_rst

 # Prevent plt.show() from emitting a non-GUI backend warning.
 warnings.filterwarnings('ignore', category=UserWarning,
    'reference_url': {'matplotlib': None, 'mpl_toolkits': None},
    'prefer_full_module': {r'mpl_toolkits\.'},
    'remove_config_comments': True,
    'reset_modules': ('matplotlib', clear_basic_units),
    'reset_modules': ('matplotlib', clear_basic_units, 'sphinxext.util.patch_header'),
    'subsection_order': gallery_order_sectionorder,
    'thumbnail_size': (320, 224),
    'within_subsection_order': gallery_order_subsectionorder,
 mathmpl_fontsize = 11.0
 mathmpl_srcset = ['2x']

 # Monkey-patching gallery header to include search keywords
 gen_rst.EXAMPLE_HEADER = """
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
 .. "{0}"
 .. LINE NUMBERS ARE GIVEN BELOW.

 .. only:: html

    .. meta::
        :keywords: codex

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_{1}>`
        to download the full example code{2}

 .. rst-class:: sphx-glr-example-title

 .. _sphx_glr_{1}:

 """

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/doc/sphinxext/util.py b/doc/sphinxext/util.py
 import sys

 from sphinx_gallery import gen_rst


 def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
                                     **kwargs):
 # Clear basic_units module to re-register with unit registry on import.
 def clear_basic_units(gallery_conf, fname):
    return sys.modules.pop('basic_units', None)


 # Monkey-patching gallery header to include search keywords
 EXAMPLE_HEADER = """
 .. DO NOT EDIT.
 .. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
 .. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
 .. "{0}"
 .. LINE NUMBERS ARE GIVEN BELOW.

 .. only:: html

    .. meta::
        :keywords: codex

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_{1}>`
        to download the full example code{2}

 .. rst-class:: sphx-glr-example-title

 .. _sphx_glr_{1}:

 """


 def patch_header(gallery_conf, fname):
    gen_rst.EXAMPLE_HEADER = EXAMPLE_HEADER
diff --git a/lib/matplotlib/tests/test_doc.py b/lib/matplotlib/tests/test_doc.py
    This test monitors that the version we have copied is still the same as
    the EXAMPLE_HEADER in sphinx-gallery. If sphinx-gallery changes its
    EXAMPLE_HEADER, this test will start to fail. In that case, please update
    the monkey-patching of EXAMPLE_HEADER inconf.py.
    the monkey-patching of EXAMPLE_HEADER insphinxext/util.py.
    """
 pytest.importorskip('sphinx_gallery',minversion='0.20.0')
 fromsphinx_galleryimportgen_rst
Original file line number	Diff line number	Diff line change
Expand Up		@@ -200,8 +200,6 @@ def _check_dependencies():
		else:
		sg_matplotlib_animations = True

		# The following import is only necessary to monkey patch the signature later on
		from sphinx_gallery import gen_rst

		# Prevent plt.show() from emitting a non-GUI backend warning.
		warnings.filterwarnings('ignore', category=UserWarning,
Expand DownExpand Up		@@ -299,7 +297,7 @@ def autodoc_process_bases(app, name, obj, options, bases):
		'reference_url': {'matplotlib': None, 'mpl_toolkits': None},
		'prefer_full_module': {r'mpl_toolkits\.'},
		'remove_config_comments': True,
		'reset_modules': ('matplotlib', clear_basic_units),
		'reset_modules': ('matplotlib', clear_basic_units, 'sphinxext.util.patch_header'),
		'subsection_order': gallery_order_sectionorder,
		'thumbnail_size': (320, 224),
		'within_subsection_order': gallery_order_subsectionorder,
Expand DownExpand Up		@@ -347,31 +345,6 @@ def gallery_image_warning_filter(record):
		mathmpl_fontsize = 11.0
		mathmpl_srcset = ['2x']

		# Monkey-patching gallery header to include search keywords
		gen_rst.EXAMPLE_HEADER = """
		.. DO NOT EDIT.
		.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
		.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
		.. "{0}"
		.. LINE NUMBERS ARE GIVEN BELOW.

		.. only:: html

		.. meta::
		:keywords: codex

		.. note::
		:class: sphx-glr-download-link-note

		:ref:`Go to the end <sphx_glr_download_{1}>`
		to download the full example code{2}

		.. rst-class:: sphx-glr-example-title

		.. _sphx_glr_{1}:

		"""

		# Add any paths that contain templates here, relative to this directory.
		templates_path = ['_templates']

Expand Down
Original file line number	Diff line number	Diff line change
		@@ -1,5 +1,7 @@
		import sys

		from sphinx_gallery import gen_rst


		def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
		**kwargs):
Expand All		@@ -19,3 +21,33 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
		# Clear basic_units module to re-register with unit registry on import.
		def clear_basic_units(gallery_conf, fname):
		return sys.modules.pop('basic_units', None)


		# Monkey-patching gallery header to include search keywords
		EXAMPLE_HEADER = """
		.. DO NOT EDIT.
		.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
		.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
		.. "{0}"
		.. LINE NUMBERS ARE GIVEN BELOW.

		.. only:: html

		.. meta::
		:keywords: codex

		.. note::
		:class: sphx-glr-download-link-note

		:ref:`Go to the end <sphx_glr_download_{1}>`
		to download the full example code{2}

		.. rst-class:: sphx-glr-example-title

		.. _sphx_glr_{1}:

		"""


		def patch_header(gallery_conf, fname):
		gen_rst.EXAMPLE_HEADER = EXAMPLE_HEADER
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,7 +7,7 @@ def test_sphinx_gallery_example_header():
		This test monitors that the version we have copied is still the same as
		the EXAMPLE_HEADER in sphinx-gallery. If sphinx-gallery changes its
		EXAMPLE_HEADER, this test will start to fail. In that case, please update
		the monkey-patching of EXAMPLE_HEADER inconf.py.
		the monkey-patching of EXAMPLE_HEADER insphinxext/util.py.
		"""
		pytest.importorskip('sphinx_gallery',minversion='0.20.0')
		fromsphinx_galleryimportgen_rst
Expand Down