Merge pull request #169 from akhmerov/builder-display-priority

Allow mime bundles display different content based on the builder

Author: akhmerov

doc/source/index.rst

@@ -437,15 +437,22 @@ jupyter_execute_default_kernel
     The default is ``python3``.
 
 
-jupyter_execute_data_priority
+render_priority_html
 
-    The display priority of different output mimetypes. Mimetypes earlier in the data priority
+    The priority of different output mimetypes for displaying in HTML output. Mimetypes earlier in the data priority
     list are preferred over later ones. This is relevant if a code cell produces an output
     that has several possible representations (e.g. description text or an image).
+    Please open an issue if you find a mimetype that isn't supported, but should be.
     The default is
     ``['application/vnd.jupyter.widget-view+json', 'text/html', 'image/svg+xml', 'image/png', 'image/jpeg', 'text/latex', 'text/plain']``.
 
 
+render_priority_latex
+
+    Same, as ``render_priority_html``, but for latex. The default is
+    ``['image/svg+xml', 'image/png', 'image/jpeg', 'text/latex', 'text/plain']``.
+
+
 jupyter_execute_kwargs
 
     Keyword arguments to pass to ``nbconvert.preprocessors.execute.executenb``, which controls how
@@ -469,6 +476,7 @@ Release 0.4.0
 - Allow adding inputs and outputs that are not executed using ``jupyter-input`` and ``jupyter-output`` directives.
 - Improve script handling by using ``nbconvert`` directly.
 - Remove deprecated enabling of the extension as ``jupyter_sphinx.execute``.
+- Implement different output priorities in HTML and LaTeX builders. In practice this allows to provide a better fallback in PDF output.
 
 Release 0.3.0
 ~~~~~~~~~~~~~

jupyter_sphinx/__init__.py

@@ -17,14 +17,13 @@
     CellInputNode,
     CellOutput,
     CellOutputNode,
-    CellOutputBundleNode,
+    MimeBundleNode,
     JupyterKernelNode,
     JupyterWidgetViewNode,
     JupyterWidgetStateNode,
     WIDGET_VIEW_MIMETYPE,
     JupyterDownloadRole,
     CombineCellInputOutput,
-    CellOutputsToNodes,
 )
 from .execute import JupyterKernel, ExecuteJupyterCells
 from .thebelab import ThebeButton, ThebeButtonNode, ThebeOutputNode, ThebeSourceNode
@@ -152,7 +151,7 @@ def setup(app):
     )
     app.add_config_value("jupyter_execute_default_kernel", "python3", "env")
     app.add_config_value(
-        "jupyter_execute_data_priority",
+        "render_priority_html",
         [
             WIDGET_VIEW_MIMETYPE,
             "application/javascript",
@@ -165,6 +164,17 @@ def setup(app):
         ],
         "env",
     )
+    app.add_config_value(
+        "render_priority_latex",
+        [
+            "image/svg+xml",
+            "image/png",
+            "image/jpeg",
+            "text/latex",
+            "text/plain",
+        ],
+        "env",
+    )
 
     # ipywidgets config
     app.add_config_value("jupyter_sphinx_require_url", REQUIRE_URL_DEFAULT, "html")
@@ -190,7 +200,7 @@ def setup(app):
     )
 
     # Register our container nodes, these should behave just like a regular container
-    for node in [JupyterCellNode, CellInputNode, CellOutputNode]:
+    for node in [JupyterCellNode, CellInputNode, CellOutputNode, MimeBundleNode]:
         app.add_node(
             node,
             override=True,
@@ -201,18 +211,6 @@ def setup(app):
             man=(render_container),
         )
 
-    # Register the output bundle node.
-    # No translators should touch this node because we'll replace it in a post-transform
-    app.add_node(
-        CellOutputBundleNode,
-        override=True,
-        html=(halt, None),
-        latex=(halt, None),
-        textinfo=(halt, None),
-        text=(halt, None),
-        man=(halt, None),
-    )
-
     # JupyterWidgetViewNode holds widget view JSON,
     # but is only rendered properly in HTML documents.
     app.add_node(
@@ -278,7 +276,6 @@ def setup(app):
     app.add_role("jupyter-download:script", JupyterDownloadRole())
     app.add_transform(CombineCellInputOutput)
     app.add_transform(ExecuteJupyterCells)
-    app.add_transform(CellOutputsToNodes)
 
     # For syntax highlighting
     app.add_lexer("ipythontb", IPythonTracebackLexer)