Skip to content

DOC: Use video files for saving animations #27797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ksunden merged 1 commit into from
Aug 9, 2024
Merged

DOC: Use video files for saving animations #27797

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,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 @@ -273,7 +278,7 @@ def tutorials_download_error(record):
'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},
Expand Down
1 change: 1 addition & 0 deletions requirements/doc/doc-requirements.txt
View file
Open in desktop
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