DOC: Use video files for saving animations

QuLogic · QuLogic · commit 1673efb58eb4 · 2024-02-15T22:57:05.000-05:00
Because the default is Base64-encoded frames of PNGs, this should save a
substantial amount of space in the resulting docs.
diff --git a/doc/conf.py b/doc/conf.py
@@ -252,7 +252,7 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
     'image_scrapers': (matplotlib_reduced_latex_scraper, ),
     'image_srcset': ["2x"],
     'junit': '../test-results/sphinx-gallery/junit.xml' if CIRCLECI else '',
-    'matplotlib_animations': True,
+    'matplotlib_animations': (True, 'mp4'),
     'min_reported_time': 1,
     'plot_gallery': 'True',  # sphinx-gallery/913
     'reference_url': {'matplotlib': None},
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -18,7 +18,8 @@ pydata-sphinx-theme~=0.13.1
 mpl-sphinx-theme~=3.8.0
 pyyaml
 sphinxcontrib-svg2pdfconverter>=1.1.0
-sphinx-gallery>=0.12.0
+git+https://github.com/QuLogic/sphinx-gallery@anim-options
+git+https://github.com/QuLogic/sphinxcontrib-video@local-video
 sphinx-copybutton
 sphinx-design
 sphinx-tags>=0.3.0
