Merge pull request #21896 from meeseeksmachine/auto-backport-of-pr-21890-on-v3.5.x

timhoffm · web-flow · commit 7faefddcbe93 · 2021-12-09T22:31:51.000+01:00
Backport PR #21890 on branch v3.5.x (Drop retina images when building PDF docs)
diff --git a/doc/conf.py b/doc/conf.py
@@ -167,6 +167,21 @@ def _check_dependencies():
 
 # Sphinx gallery configuration
 
+def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
+                                     **kwargs):
+    """
+    Reduce srcset when creating a PDF.
+
+    Because sphinx-gallery runs *very* early, we cannot modify this even in the
+    earliest builder-inited signal. Thus we do it at scraping time.
+    """
+    from sphinx_gallery.scrapers import matplotlib_scraper
+
+    if gallery_conf['builder_name'] == 'latex':
+        gallery_conf['image_srcset'] = []
+    return matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)
+
+
 sphinx_gallery_conf = {
     'examples_dirs': ['../examples', '../tutorials', '../plot_types'],
     'filename_pattern': '^((?!sgskip).)*$',
@@ -183,6 +198,7 @@ def _check_dependencies():
     'remove_config_comments': True,
     'min_reported_time': 1,
     'thumbnail_size': (320, 224),
+    'image_scrapers': (matplotlib_reduced_latex_scraper, ),
     # Compression is a significant effort that we skip for local and CI builds.
     'compress_images': ('thumbnails', 'images') if is_release_build else (),
     'matplotlib_animations': True,
