Merge pull request #114 from AakashGfude/image-mimetype

Checking if the image path is inside a subdir of dir

Author: akhmerov

jupyter_sphinx/ast.py

@@ -274,6 +274,14 @@ def cell_output_to_nodes(cell, data_priority, write_stderr, dir, thebe_config):
                 # directory, so make a relative path, which Sphinx treats
                 # as being relative to the current working directory.
                 filename = os.path.basename(output.metadata["filenames"][mime_type])
+
+                # checks if file dir path is inside a subdir of dir
+                filedir = os.path.dirname(output.metadata["filenames"][mime_type])
+                subpaths = filedir.split(dir)
+                if subpaths and len(subpaths) > 1:
+                    subpath = subpaths[1]
+                    dir += subpath
+
                 uri = os.path.join(dir, filename)
                 to_add.append(docutils.nodes.image(uri=uri))
             elif mime_type == "text/html":

tests/test_execute.py

@@ -7,13 +7,15 @@
 from sphinx.testing.util import SphinxTestApp, path
 from sphinx.errors import ExtensionError
 from docutils.nodes import raw
+from nbformat import from_dict
 
 import pytest
 
 from jupyter_sphinx.ast import (
     JupyterCellNode,
     JupyterWidgetViewNode,
     JupyterWidgetStateNode,
+    cell_output_to_nodes,
 )
 from jupyter_sphinx.thebelab import ThebeSourceNode, ThebeOutputNode, ThebeButtonNode
 
@@ -512,3 +514,23 @@ def test_latex(doctree):
         tree = doctree(source.format(start, end))
         (cell,) = tree.traverse(JupyterCellNode)
         assert cell.children[1].astext() == r"\int"
+
+
+def test_image_mimetype_uri(doctree):
+    # tests the image uri paths on conversion to docutils image nodes
+    priority =  ['image/png', 'image/jpeg', 'text/latex', 'text/plain']
+    output_dir = '/_build/jupyter_execute'
+    img_locs = ['/_build/jupyter_execute/docs/image_1.png','/_build/jupyter_execute/image_2.png']
+
+    cells = [
+        {'outputs': 
+            [{'data': {'image/png': 'Vxb6L1wAAAABJRU5ErkJggg==\n', 'text/plain': '<Figure size 432x288 with 1 Axes>'}, 'metadata': {'filenames': {'image/png': img_locs[0]}}, 'output_type': 'display_data'}]
+        },
+        {'outputs': 
+            [{'data': {'image/png': 'iVBOJggg==\n', 'text/plain': '<Figure size 432x288 with 1 Axes>'}, 'metadata': {'filenames': {'image/png': img_locs[1]}}, 'output_type': 'display_data'}]
+        }]
+
+    for index, cell in enumerate(cells):
+        cell = from_dict(cell)
+        output_node = cell_output_to_nodes(cell, priority, True, output_dir, None)
+        assert output_node[0].attributes['uri'] == img_locs[index]