Update video extension so manually copying to build dir not needed

Author: Steven-Roberts

docs/conf.py

@@ -1,34 +1,6 @@
 from datetime import datetime
 from yaml import safe_load
 
-import os
-import shutil
-
-def copy_webm_files(source_dir, destination_dir):
-    # Get a list of all files in the source directory
-    files = os.listdir(source_dir)
-
-    if not os.path.exists(destination_directory):
-        os.makedirs(destination_directory)
-
-    # Iterate over each file
-    for file in files:
-        # Check if the file is a .webm file
-        if file.endswith(".webm"):
-            # Create the full path of the source file
-            source_file = os.path.join(source_dir, file)
-
-            # Create the full path of the destination file
-            destination_file = os.path.join(destination_dir, file)
-
-            # Copy the file to the destination directory
-            shutil.copy2(source_file, destination_file)
-
-
-source_directory = "../images/animations/"
-destination_directory = "../docs/build/_static"
-copy_webm_files(source_directory, destination_directory)
-
 with open('../DESCRIPTION') as stream:
     otp = safe_load(stream)
 
@@ -78,5 +50,3 @@ def copy_webm_files(source_dir, destination_dir):
 html_theme_options = {
     'logo_only': True
 }
-
-

docs/requirements.txt

@@ -5,7 +5,7 @@ sphinxcontrib-matlabdomain==0.21.4
 sphinxcontrib-napoleon==0.7
 sphinx-math-dollar==1.2.1
 sphinxcontrib-bibtex==2.6.2
-sphinxcontrib-video==0.2.0
+sphinxcontrib-video==0.2.1
 setuptools==70.0.0 # Now required in python 3.12+
 myst-parser==2.0.0
 pyyaml==6.0.1

docs/usage.rst

@@ -1,12 +1,14 @@
 Getting Started
 ================================================================================
-This guide shows you how to create, solve and visualize different problems in ODE Test Problems (``OTP``).
+
+This guide shows you how to create, solve and visualize different problems in
+ODE Test Problems (OTP).
 
 Mathematical formulation
------------------------------
+------------------------
 
-All test problems in ``OTP`` are considered as a first-order
-differential-algebraic equation of the form
+All test problems in OTP are considered as a first-order differential-algebraic
+equation of the form
 
 .. math::
 
@@ -95,9 +97,10 @@ diagram by visualizing all spatial-components of the state vector.
    problem.plotPhaseSpace(sol);
 
 .. image:: ../images/Lorenz-solution-plot.png
-      :width: 200
-.. image:: ../images/Lorenz-Phase-plot.png
-      :width: 200
+   :width: 256
+
+.. image:: ../images/Lorenz-phase-plot.png
+   :width: 256
 
 ``OTP`` also supports animations for the computed solution:
 
@@ -106,9 +109,10 @@ diagram by visualizing all spatial-components of the state vector.
    % Create a movie of the solution 
    problem.movie(sol);
 
-.. video:: ../_static/Lorenz-Original-Canonical.webm
-      :loop: 
-      :width: 200
+.. video:: ../images/animations/Lorenz-original-canonical.webm
+   :autoplay:
+   :loop:
+   :width: 256
 
 Changing the parameters
 ------------------------
@@ -125,9 +129,12 @@ For example, changing the parameter :math:`\rho` in the Lorenz system leads to a
    sol = problem.solve('MaxStep' , 1e-4);
    problem.movie(sol);
 
-.. video:: ../_static/Lorenz-Alternate-Canonical.webm
-      :loop: 
-      :width: 200
+.. video:: ../images/animations/Lorenz-alternate-canonical.webm
+   :autoplay:
+   :loop:
+   :width: 256
+   :class: center
+
 Changing the solver
 -------------------
 
@@ -141,10 +148,11 @@ following code:
 
    sol = ode23s(problem.RHS.F, problem.TimeSpan, problem.Y0, ...
                 odeset('Jacobian', problem.RHS.Jacobian));
+
 This is particularly useful when you want to compare the performance of different solvers on the same problem.
 
 Next steps
 ------------------------
 Explore different problems available in OTP by browsing the Problems Gallery in the sidebar. You can define your custom 
 problems by creating a new class that inherits from the ``otp.Problem`` class. 
-See the `Contributing Guide <../contributing>`_  for more details.
+See the `Contributing Guide <../contributing>`_  for more details.