Fixes for Sphinx 7.3 and sphinx-gallery 0.16

Author: sdhiscocks

docs/source/conf.py

@@ -24,8 +24,6 @@
 sys.path.insert(0, os.path.abspath('.'))
 sys.path.insert(0, os.path.abspath('../../'))
 
-from doc_extensions import gallery_scraper, reset_numpy_random_seed
-from sphinx_gallery.sorting import FileNameSortKey
 import plotly.io as pio
 pio.renderers.default = 'sphinx_gallery'
 
@@ -66,14 +64,14 @@
     'examples_dirs': ['../tutorials', '../examples', '../demos'],
     'gallery_dirs': ['auto_tutorials', 'auto_examples', 'auto_demos'],
     'filename_pattern': re.escape(os.sep),
-    'image_scrapers': (gallery_scraper(),),
-    'reset_modules': ('matplotlib', 'seaborn', reset_numpy_random_seed()),
+    'image_scrapers': ('doc_extensions.gallery_scraper',),
+    'reset_modules': ('matplotlib', 'seaborn', 'doc_extensions.reset_numpy_random_seed'),
     'reset_modules_order': 'both',
     'abort_on_example_error': False,
     'reference_url': {'stonesoup': None},
     'remove_config_comments': True,
     'ignore_repr_types': r'matplotlib\.(?:figure|animation|legend)',
-    'within_subsection_order': FileNameSortKey,
+    'within_subsection_order': "FileNameSortKey",
     'matplotlib_animations': True,
     'notebook_images':
         f'https://stonesoup.rtfd.io/en/{os.environ.get("READTHEDOCS_VERSION", "latest")}/',
@@ -162,8 +160,6 @@
 # If true, keep warnings as "system message" paragraphs in the built documents.
 # keep_warnings = False
 
-suppress_warnings = ["config.cache"]
-
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 

docs/source/doc_extensions.py

@@ -1,8 +1,27 @@
 import re
 from collections.abc import Sequence
+from pathlib import PurePosixPath
+from textwrap import indent
+
+import numpy as np
+import matplotlib
+import matplotlib.pyplot as plt
+from matplotlib.animation import Animation
+from matplotlib.figure import Figure
+from sphinx_gallery.scrapers import (
+    figure_rst, _anim_rst, _matplotlib_fig_titles, HLIST_HEADER,
+    HLIST_IMAGE_MATPLOTLIB)
+import plotly.graph_objects as go
+try:
+    import kaleido  # noqa: F401
+except ImportError:
+    write_plotly_image = None
+else:
+    from plotly.io import write_image as write_plotly_image
 
 from stonesoup.base import Base
 
+
 STONESOUP_TYPE_REGEX = re.compile(r'stonesoup\.(\w+\.)*')
 
 
@@ -70,25 +89,7 @@ def setup(app):
     app.connect('autodoc-process-signature', shorten_type_hints)
 
 
-import os
-import matplotlib
-import matplotlib.pyplot as plt
-from textwrap import indent
-
-from sphinx_gallery.scrapers import (
-    figure_rst, _anim_rst, _matplotlib_fig_titles, HLIST_HEADER,
-    HLIST_IMAGE_MATPLOTLIB)
-
-import plotly.graph_objects as go
-try:
-    import kaleido
-except ImportError:
-    write_plotly_image = None
-else:
-    from plotly.io import write_image as write_plotly_image
-
-
-class gallery_scraper():
+class GalleryScraper():
     def __init__(self):
         self.plotted_figures = set()
         self.current_src_file = None
@@ -124,18 +125,15 @@ def __call__(self, block, block_vars, gallery_conf, **kwargs):
             self.plotted_figures = set()
             self.current_src_file = block_vars['src_file']
 
-        from matplotlib.animation import Animation
-        from matplotlib.figure import Figure
         image_path_iterator = block_vars['image_path_iterator']
         image_rsts = []
 
         # Check for animations
-        anims = list()
-        if gallery_conf.get('matplotlib_animations', False):
+        anims = {}
+        if gallery_conf['matplotlib_animations']:
             for ani in block_vars['example_globals'].values():
                 if isinstance(ani, Animation):
-                    anims.append(ani)
-
+                    anims[ani._fig] = ani
         # Then standard images
         new_figures = set(plt.get_fignums()) - self.plotted_figures
         last_line = block[1].strip().split('\n')[-1]
@@ -149,30 +147,22 @@ def __call__(self, block, block_vars, gallery_conf, **kwargs):
         else:
             if isinstance(output, Figure):
                 new_figures.add(output.number)
-            elif isinstance(output, go.Figure):
-                if write_plotly_image is not None:
-                    image_path = next(image_path_iterator)
-                    if 'format' in kwargs:
-                        image_path = '%s.%s' % (os.path.splitext(image_path)[0],
-                                                kwargs['format'])
-                    write_plotly_image(output, image_path, kwargs.get('format'))
+            elif isinstance(output, go.Figure) and write_plotly_image is not None:
+                image_path = PurePosixPath(next(image_path_iterator))
+                if "format" in kwargs:
+                    image_path = image_path.with_suffix("." + kwargs["format"])
+                write_plotly_image(output, str(image_path), kwargs.get('format'))
 
         for fig_num, image_path in zip(new_figures, image_path_iterator):
-            if 'format' in kwargs:
-                image_path = '%s.%s' % (os.path.splitext(image_path)[0],
-                                        kwargs['format'])
-            # Set the fig_num figure as the current figure as we can't
-            # save a figure that's not the current figure.
+            image_path = PurePosixPath(image_path)
+            if "format" in kwargs:
+                image_path = image_path.with_suffix("." + kwargs["format"])
+            # Convert figure number to Figure.
             fig = plt.figure(fig_num)
             self.plotted_figures.add(fig_num)
             # Deal with animations
-            cont = False
-            for anim in anims:
-                if anim._fig is fig:
-                    image_rsts.append(_anim_rst(anim, image_path, gallery_conf))
-                    cont = True
-                    break
-            if cont:
+            if anim := anims.get(fig):
+                image_rsts.append(_anim_rst(anim, image_path, gallery_conf))
                 continue
             # get fig titles
             fig_titles = _matplotlib_fig_titles(fig)
@@ -183,8 +173,7 @@ def __call__(self, block, block_vars, gallery_conf, **kwargs):
             for attr in ['facecolor', 'edgecolor']:
                 fig_attr = getattr(fig, 'get_' + attr)()
                 default_attr = matplotlib.rcParams['figure.' + attr]
-                if to_rgba(fig_attr) != to_rgba(default_attr) and \
-                        attr not in kwargs:
+                if to_rgba(fig_attr) != to_rgba(default_attr) and attr not in kwargs:
                     these_kwargs[attr] = fig_attr
             these_kwargs['bbox_inches'] = "tight"
             fig.savefig(image_path, **these_kwargs)
@@ -194,24 +183,28 @@ def __call__(self, block, block_vars, gallery_conf, **kwargs):
         if len(image_rsts) == 1:
             rst = image_rsts[0]
         elif len(image_rsts) > 1:
-            image_rsts = [re.sub(r':class: sphx-glr-single-img',
-                                 ':class: sphx-glr-multi-img',
-                                 image) for image in image_rsts]
-            image_rsts = [HLIST_IMAGE_MATPLOTLIB + indent(image, u' ' * 6)
-                          for image in image_rsts]
+            image_rsts = [
+                re.sub(r':class: sphx-glr-single-img', ':class: sphx-glr-multi-img', image)
+                for image in image_rsts]
+            image_rsts = [
+                HLIST_IMAGE_MATPLOTLIB + indent(image, ' ' * 6) for image in image_rsts
+            ]
             rst = HLIST_HEADER + ''.join(image_rsts)
         return rst
 
 
-class reset_numpy_random_seed:
+class ResetNumPyRandomSeed:
 
     def __init__(self):
         self.state = None
 
     def __call__(self, gallery_conf, fname, when):
-        import numpy as np
         if when == 'before':
             self.state = np.random.get_state()
         elif when == 'after':
             # Set state attribute back to `None`
             self.state = np.random.set_state(self.state)
+
+
+gallery_scraper = GalleryScraper()
+reset_numpy_random_seed = ResetNumPyRandomSeed()

setup.cfg

@@ -44,7 +44,7 @@ dev =
     pytest-skip-slow
     Sphinx
     sphinx_rtd_theme>=1.2
-    sphinx-gallery>=0.10.1
+    sphinx-gallery>=0.16
 video =
     ffmpeg-python
     moviepy