Skip to content

Commit

Permalink
Backport PR #27797: DOC: Use video files for saving animations
Browse files Browse the repository at this point in the history
  • Loading branch information
ksunden authored and meeseeksmachine committed Aug 9, 2024
1 parent e3159ba commit d88a582
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
7 changes: 6 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,11 @@ def _check_dependencies():
subsectionorder as gallery_order_subsectionorder)
from sphinxext.util import clear_basic_units, matplotlib_reduced_latex_scraper

if parse_version(sphinx_gallery.__version__) >= parse_version('0.17.0'):
sg_matplotlib_animations = (True, 'mp4')
else:
sg_matplotlib_animations = True

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

Expand Down Expand Up @@ -260,7 +265,7 @@ def _check_dependencies():
'image_scrapers': (matplotlib_reduced_latex_scraper, ),
'image_srcset': ["2x"],
'junit': '../test-results/sphinx-gallery/junit.xml' if CIRCLECI else '',
'matplotlib_animations': True,
'matplotlib_animations': sg_matplotlib_animations,
'min_reported_time': 1,
'plot_gallery': 'True', # sphinx-gallery/913
'reference_url': {'matplotlib': None, 'mpl_toolkits': None},
Expand Down
1 change: 1 addition & 0 deletions requirements/doc/doc-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ pydata-sphinx-theme~=0.15.0
mpl-sphinx-theme~=3.9.0
pyyaml
sphinxcontrib-svg2pdfconverter>=1.1.0
sphinxcontrib-video>=0.2.1
sphinx-copybutton
sphinx-design
sphinx-gallery>=0.12.0
Expand Down

0 comments on commit d88a582

Please sign in to comment.