Merge pull request #130 from choldgraf/inline_nodes

adding inline functionality to nodes function

Author: akhmerov

jupyter_sphinx/ast.py

@@ -229,7 +229,8 @@ def html(self):
         )
 
 
-def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_config):
+def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir,
+                         thebe_config, inline=False):
     """Convert a jupyter cell with outputs and filenames to doctree nodes.
 
     Parameters
@@ -244,12 +245,22 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_co
         to the source folder prefixed with ``/``.
     thebe_config: dict
         Thebelab configuration object or None
+    inline: False
+        Whether the nodes will be placed in-line with the text.
 
     Returns
     -------
     to_add : list of docutils nodes
         Each output, converted into a docutils node.
     """
+    # If we're in `inline` mode, ensure that we don't add block-level nodes
+    if inline:
+        literal_node = docutils.nodes.literal
+        math_node = docutils.nodes.math
+    else:
+        literal_node = docutils.nodes.literal_block
+        math_node = math_block
+
     to_add = []
     for output in outputs:
         output_type = output["output_type"]
@@ -267,19 +278,22 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_co
                     # Not setting "rawsource" disables Pygment hightlighting, which
                     # would otherwise add a <div class="highlight">.
 
-                    container = docutils.nodes.container(classes=["stderr"])
-                    container.append(
-                        docutils.nodes.literal_block(
-                            text=output["text"],
-                            rawsource="",  # disables Pygment highlighting
-                            language="none",
-                            classes=["stderr"],
-                        )
+                    literal = literal_node(
+                        text=output["text"],
+                        rawsource="",  # disables Pygment highlighting
+                        language="none",
+                        classes=["stderr"],
                     )
-                    to_add.append(container)
+                    if inline:
+                        # In this case, we don't wrap the text in containers
+                        to_add.append(literal)
+                    else:
+                        container = docutils.nodes.container(classes=["stderr"])
+                        container.append(literal)
+                        to_add.append(container)
             else:
                 to_add.append(
-                    docutils.nodes.literal_block(
+                    literal_node(
                         text=output["text"],
                         rawsource=output["text"],
                         language="none",
@@ -290,7 +304,7 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_co
             traceback = "\n".join(output["traceback"])
             text = nbconvert.filters.strip_ansi(traceback)
             to_add.append(
-                docutils.nodes.literal_block(
+                literal_node(
                     text=text,
                     rawsource=text,
                     language="ipythontb",
@@ -325,7 +339,7 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_co
                 )
             elif mime_type == "text/latex":
                 to_add.append(
-                    math_block(
+                    math_node(
                         text=strip_latex_delimiters(data),
                         nowrap=False,
                         number=None,
@@ -334,7 +348,7 @@ def cell_output_to_nodes(outputs, data_priority, write_stderr, out_dir, thebe_co
                 )
             elif mime_type == "text/plain":
                 to_add.append(
-                    docutils.nodes.literal_block(
+                    literal_node(
                         text=data,
                         rawsource=data,
                         language="none",

tests/test_execute.py

@@ -9,7 +9,7 @@
 from sphinx.addnodes import download_reference
 from sphinx.testing.util import assert_node, SphinxTestApp, path
 from sphinx.errors import ExtensionError
-from docutils.nodes import literal, raw
+from docutils.nodes import raw, literal, literal_block, container
 from nbformat import from_dict
 
 import pytest
@@ -551,7 +551,7 @@ def test_latex(doctree):
         assert celloutput.children[0].astext() == r"\int"
 
 
-def test_image_mimetype_uri(doctree):
+def test_cell_output_to_nodes(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'
@@ -570,6 +570,19 @@ def test_image_mimetype_uri(doctree):
         output_node = cell_output_to_nodes(cell["outputs"], priority, True, output_dir, None)
         assert output_node[0].attributes['uri'] == img_locs[index]
 
+    # Testing inline functionality
+    outputs = [
+        {"name": "stdout", "output_type": "stream", "text": ["hi\n"]},
+        {"name": "stderr", "output_type": "stream", "text": ["hi\n"]},
+    ]
+    output_nodes = cell_output_to_nodes(outputs, priority, True, output_dir, None)
+    for output, kind in zip(output_nodes, [literal_block, container]):
+        assert isinstance(output, kind)
+
+    output_nodes = cell_output_to_nodes(outputs, priority, True, output_dir, None, inline=True)
+    for output, kind in zip(output_nodes, [literal, literal]):
+        assert isinstance(output, kind)
+
 
 @pytest.mark.parametrize('text,reftarget,caption', (
     ('nb_name', '/../jupyter_execute/path/to/nb_name.ipynb', 'nb_name.ipynb'),
@@ -596,3 +609,4 @@ def test_download_role(text, reftarget, caption, tmp_path):
     assert_node(ret[0], [download_reference], reftarget=reftarget)
     assert_node(ret[0][0], [literal, caption])
     assert msg == []
+