FIX: fix template for multi image [ci doc]

jklymak · jklymak · commit bfc7dca2e313 · 2023-03-21T14:01:27.000-07:00
diff --git a/lib/matplotlib/sphinxext/figmpl_directive.py b/lib/matplotlib/sphinxext/figmpl_directive.py
@@ -18,6 +18,8 @@
 
 from sphinx.errors import ExtensionError
 
+import matplotlib
+
 
 class figmplnode(nodes.General, nodes.Element):
     pass
@@ -106,7 +108,10 @@ def _copy_images_figmpl(self, node):
 
     # these will be the temporary place the plot-directive put the images eg:
     # ../../../build/html/plot_directive/users/explain/artists/index-1.png
-    srcset = _parse_srcsetNodes(node['srcset'])
+    if node['srcset']:
+        srcset = _parse_srcsetNodes(node['srcset'])
+    else:
+        srcset = None
 
     # the rst file's location:  eg /Users/username/matplotlib/doc/users/explain/artists
     docsource = PurePosixPath(self.document['source']).parent
@@ -123,19 +128,24 @@ def _copy_images_figmpl(self, node):
     Path(imagedir).mkdir(parents=True, exist_ok=True)
 
     # copy all the sources to the imagedir:
-    for mult in srcset:
-        # the entries in srcset are relative to docsource's directory
-        abspath = PurePosixPath(docsource, srcset[mult])
+    if srcset:
+        for mult in srcset:
+            # the entries in srcset are relative to docsource's directory
+            abspath = PurePosixPath(docsource, srcset[mult])
+            shutil.copyfile(abspath, imagedir / abspath.name)
+    else:
+        abspath = PurePosixPath(docsource, node['uri'])
         shutil.copyfile(abspath, imagedir / abspath.name)
 
+
     return imagedir, srcset
 
 
 def visit_figmpl_html(self, node):
 
-    if node['srcset'] is None:
-        self.visit_image(node)
-        return
+    #if node['srcset'] is None:
+    #    print('NODE: NONE')
+    #    return self.visit_figure(node)
 
     imagedir, srcset = _copy_images_figmpl(self, node)
 
@@ -158,34 +168,42 @@ def visit_figmpl_html(self, node):
     else:  # html
         imagerel = imagerel + ''
 
-    # make srcset str.  Need to change all the prefixes!
-    srcsetst = ''
-    maxmult = -1
-    for mult in srcset:
-        nm = PurePosixPath(srcset[mult][1:]).name
-        # ../../_images/plot_1_2_0x.png
-        path = imagerel + '/' + nm
-        srcsetst += f'{path}'
-        if mult == 0:
-            srcsetst += ', '
-        else:
-            srcsetst += f' {mult:1.2f}x, '
-
-        if mult > maxmult:
-            maxmult = mult
-            maxsrc = path
-
-    # trim trailing comma and space...
-    srcsetst = srcsetst[:-2]
-
     # make uri also be relative...
     nm = PurePosixPath(node['uri'][1:]).name
     uri = imagerel + '/' + nm
 
+
+    # make srcset str.  Need to change all the prefixes!
+    if srcset:
+        srcsetst = ''
+        maxmult = -1
+        for mult in srcset:
+            nm = PurePosixPath(srcset[mult][1:]).name
+            # ../../_images/plot_1_2_0x.png
+            path = imagerel + '/' + nm
+            srcsetst += f'{path}'
+            if mult == 0:
+                srcsetst += ', '
+            else:
+                srcsetst += f' {mult:1.2f}x, '
+
+            if mult > maxmult:
+                maxmult = mult
+                maxsrc = path
+
+        # trim trailing comma and space...
+        srcsetst = srcsetst[:-2]
+    else:
+        srcsetst = ''
+        maxsrc = uri
+
     alt = node['alt']
     if node['class'] is not None:
-        classst = node['class'][0]
+        classst = ''
+        for cl in node['class']:
+            classst += cl + ' '
         classst = f'class="{classst}"'
+
     else:
         classst = ''
 
@@ -230,7 +248,7 @@ def visit_figmpl_latex(self, node):
             maxmult = max(maxmult, key)
         node['uri'] = str(PurePosixPath(srcset[maxmult]).name)
 
-    self.visit_image(node)
+    self.visit_figure(node)
 
 
 def depart_figmpl_html(self, node):
@@ -248,5 +266,9 @@ def figurempl_addnode(app):
 
 
 def setup(app):
+    print('SETUPPPPP')
     app.add_directive("figure-mpl", FigureMpl)
     figurempl_addnode(app)
+    metadata = {'parallel_read_safe': True, 'parallel_write_safe': True,
+                'version': matplotlib.__version__}
+    return metadata
diff --git a/lib/matplotlib/sphinxext/plot_directive.py b/lib/matplotlib/sphinxext/plot_directive.py
@@ -531,7 +531,9 @@ def get_plot_formats(config):
 
 
 def _parse_srcset(st):
-    """ parse srcset"""
+    """
+    Parse srcset for multiples...
+    """
     entries = st.split(',')
 
     srcset = {}
@@ -860,8 +862,6 @@ def run(arguments, content, options, state_machine, state, lineno):
             source_code=source_code,
             html_show_formats=config.plot_html_show_formats and len(images),
             caption=caption)
-        #print('RESULT:', result)
-        #print('######################')
         total_lines.extend(result.split("\n"))
         total_lines.extend("\n")
 
