Skip to content

Improve video embedding in documentation #23

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
CyrilJl merged 1 commit into from
Dec 9, 2025
Merged

Improve video embedding in documentation #23

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
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"sphinx.ext.napoleon",
"sphinxawesome_theme",
"sphinx_togglebutton",
"sphinxcontrib.video",
]
html_title = project
templates_path = ["_templates"]
Expand Down
8 changes: 3 additions & 5 deletions docs/how_to_use.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,9 @@ The main function of ``mapflow`` is ``animate``, which creates a video from an `
ds = xr.tutorial.open_dataset("era5-2mt-2019-03-uk.grib")
animate(da=ds['t2m'].isel(time=slice(120)), path='animation.mp4')

.. raw:: html

<video width="640" height="480" controls>
<source src="../_static/animation.mp4" type="video/mp4">
</video>
.. video:: ../_static/animation.mp4
:width: 640
:height: 480

Creating a static plot
----------------------
Expand Down
3 changes: 2 additions & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@
xarray
matplotlib
geopandas
tqdm
tqdm
sphinxcontrib-video

Check notice on line 8 in docs/requirements.txt

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/requirements.txt#L8 

Statement seems to have no effect
Loading