👌 IMPROVE: Use configured nb_render_plugin for glue nodes (#337)

Co-authored-by: Chris Sewell <chrisj_sewell@hotmail.com>

myst_nb/nb_glue/__init__.py

@@ -5,14 +5,14 @@
 
 
 def glue(name, variable, display=True):
-    """Glue an variable into the notebook's cell metadata.
+    """Glue a variable into the notebook's cell metadata.
 
     Parameters
     ----------
     name: string
         A unique name for the variable. You can use this name to refer to the variable
         later on.
-    variable: python object
+    variable: Python object
         A variable in Python for which you'd like to store its display value. This is
         not quite the same as storing the object itself - the stored information is
         what is *displayed* when you print or show the object in a Jupyter Notebook.

myst_nb/nb_glue/domain.py

@@ -38,10 +38,10 @@ def copy(self):
         return obj
 
     def create_node(self, output: dict, document, env):
-        """Create the output node, give the cell output."""
+        """Create the output node, given the cell output."""
         # the whole output chunk is deposited and rendered later
         # TODO move these nodes to separate module, to avoid cyclic imports
-        output_node = CellOutputBundleNode([output], "default")
+        output_node = CellOutputBundleNode([output], env.config["nb_render_plugin"])
         out_node = CellOutputNode(classes=["cell_output"])
         out_node.source, out_node.line = self.source, self.line
         out_node += output_node
@@ -50,7 +50,7 @@ def create_node(self, output: dict, document, env):
 
 class PasteInlineNode(PasteNode):
     def create_node(self, output: dict, document, env):
-        """Create the output node, give the cell output."""
+        """Create the output node, given the cell output."""
         # the whole output chunk is deposited and rendered later
         bundle_node = CellOutputBundleNode([output], "inline")
         inline_node = nodes.inline("", "", bundle_node, classes=["pasted-inline"])
@@ -66,7 +66,7 @@ def formatting(self):
         return self.attributes["formatting"]
 
     def create_node(self, output: dict, document, env):
-        """Create the output node, give the cell output."""
+        """Create the output node, given the cell output."""
         mimebundle = output["data"]
         if "text/plain" in mimebundle:
             text = mimebundle["text/plain"].strip("'")
@@ -90,7 +90,7 @@ class PasteMathNode(PasteNode):
     """
 
     def create_node(self, output: dict, document, env):
-        """Create the output node, give the cell output."""
+        """Create the output node, given the cell output."""
         mimebundle = output["data"]
         if "text/latex" in mimebundle:
             text = mimebundle["text/latex"].strip("$")

myst_nb/nb_glue/utils.py

@@ -7,12 +7,12 @@
 
 
 def read_glue_cache(path):
-    """Read a glue cache generated by Sphinx build.
+    """Read a glue cache generated by a Sphinx build.
 
     Parameters
     ----------
     path : str
-        Path to a doctree dir, or directly to a glue cache .json file.
+        Path to a doctree directory, or directly to a glue cache .json file.
 
     Returns
     -------
@@ -64,10 +64,10 @@ def find_glued_key(path_ntbk, key):
                     bundle = {this_key: val for key, val in bundle.items()}
                     outputs.append(bundle)
     if len(outputs) == 0:
-        raise KeyError(f"Did not find key {this_key} in notebook {path_ntbk}")
+        raise KeyError(f"Did not find key {key} in notebook {path_ntbk}")
     if len(outputs) > 1:
         raise KeyError(
-            f"Multiple variables found for key: {this_key}. Returning first value."
+            f"Multiple variables found for key: {key}. Returning first value."
         )
     return outputs[0]
 

myst_nb/nodes.py

@@ -48,7 +48,7 @@ def metadata(self) -> NotebookNode:
 
     @property
     def renderer(self) -> str:
-        """The cell level metadata for this output."""
+        """The renderer for this output cell."""
         return self._renderer
 
     def copy(self):