Merge pull request #168 from man-group/remove-random-None

#165: Fix the word "None" appearing at the top of each report

Author: jonbannister

CHANGELOG.md

@@ -1,3 +1,7 @@
+0.6.2 (2024-xx-xx)
+------------------
+* Bugfix: None will stop appearing at the top of reports with nbconvert>7.0.0
+
 0.6.1 (2023-09-13)
 ------------------
 * Feature: GridFS document storage in Mongo-backed instances is now sharded if the mongo server supports it. 

notebooker/nbtemplates/notebooker_html_output.tpl

@@ -1,4 +1,4 @@
-{% extends 'full.tpl'%}
+{% extends 'index.html.j2' %}
 {% block html_head %}
 {{ super() }}
 <style type="text/css">
@@ -40,7 +40,9 @@ div div.cell {
     	'.prompt',
     	'.output_stream',
     	'.jp-outputPrompt',
+    	'.jp-OutputPrompt',
     	'.jp-inputPrompt',
+    	'.jp-InputPrompt',
     	'.jp-InputArea-editor',
     	'.jp-RenderedText'
     ];
@@ -93,6 +95,6 @@ div div.cell {
 
 {% block stream %}
   {%- if resources.global_content_filter.include_output_prompt -%}
-    {{ super() or "" }}
+    {{ super() }}
   {%- endif -%}
 {%- endblock stream %}

notebooker/nbtemplates/notebooker_html_output_deprecated.tpl

@@ -0,0 +1,100 @@
+{% extends 'full.tpl' %}
+{% block html_head %}
+{{ super() }}
+<style type="text/css">
+
+.btn {
+  display: inline-block;
+  text-align: center;
+  text-decoration: none;
+  margin: 2px 0;
+  border: solid 1px transparent;
+  border-radius: 4px;
+  padding: 0.5em 1em;
+  color: #ffffff;
+  background-color: #9555af;
+}
+
+.container {
+  width: 97%;
+}
+
+</style>
+
+<!--[if mso]>
+<style type="text/css">
+div div.cell {
+  border-style: none;
+  margin-top: 4;
+}
+</style>
+<![endif]-->
+
+<script>
+(function() {
+  function addToggleCodeButton() {
+
+    var hidden = true;
+    var code_blocks = [
+    	'.input',
+    	'.prompt',
+    	'.output_stream',
+    	'.jp-outputPrompt',
+    	'.jp-OutputPrompt',
+    	'.jp-inputPrompt',
+    	'.jp-InputPrompt',
+    	'.jp-InputArea-editor',
+    	'.jp-RenderedText'
+    ];
+    var show_code = function(){
+        code_blocks.forEach(
+	        function(block){
+	            var elements = document.querySelectorAll(block);
+				for(var i = 0; i < elements.length; i++){
+				    elements[i].style.display = '';
+				}
+            }
+        )
+    };
+	var hide_code = function(){
+	    code_blocks.forEach(
+	        function(block){
+	            var elements = document.querySelectorAll(block);
+				for(var i = 0; i < elements.length; i++){
+				    elements[i].style.display = 'none';
+				}
+            }
+        )
+    };
+
+    var bodyElement = document.getElementsByClassName('jp-Notebook')[0];
+    if (bodyElement === undefined) {
+        bodyElement = document.getElementById('notebook-container');
+    }
+    var toggleDiv = document.createElement('div');
+    var toggleButton = document.createElement('button');
+    toggleButton.className = 'btn';
+    toggleButton.onclick = function(){
+    	if(hidden){ show_code() } else { hide_code() };
+    	hidden = !hidden;
+	};
+
+    var toggleText = document.createTextNode('Toggle Code');
+    toggleButton.appendChild(toggleText);
+    toggleDiv.appendChild(toggleButton);
+    bodyElement.insertBefore( toggleDiv, bodyElement.firstChild);
+
+    // Default to hidden code
+	hide_code()
+  }
+
+  document.addEventListener('DOMContentLoaded', addToggleCodeButton);
+}());
+</script>
+{%- endblock html_head -%}
+
+{% block stream %}
+  {%- if resources.global_content_filter.include_output_prompt -%}
+    {{ super() }}
+  {%- endif -%}
+{%- endblock stream %}

notebooker/utils/conversion.py

@@ -4,10 +4,12 @@
 
 import git
 import jupytext
+import nbconvert
 import nbformat
 import pkg_resources
 from nbconvert import HTMLExporter, PDFExporter, SlidesExporter
 from nbconvert.exporters.exporter import ResourcesDict
+from packaging import version
 from traitlets.config import Config
 
 from notebooker.constants import TEMPLATE_DIR_SEPARATOR, kernel_spec
@@ -32,9 +34,14 @@ def ipython_to_html(
         html, resources = exporter.from_notebook_node(nb)
     else:
         c.HTMLExporter.preprocessors = ["nbconvert.preprocessors.ExtractOutputPreprocessor"]
+        if version.parse(nbconvert.__version__) >= version.parse("7.0.0"):
+            template_filename = "notebooker_html_output.tpl"
+        else:
+            template_filename = "notebooker_html_output_deprecated.tpl"
         c.HTMLExporter.template_file = pkg_resources.resource_filename(
-            __name__, "../nbtemplates/notebooker_html_output.tpl"
+            __name__, f"../nbtemplates/{template_filename}"
         )
+
         c.HTMLExporter.exclude_input = hide_code
         c.HTMLExporter.exclude_input_prompt = hide_code
         c.HTMLExporter.exclude_output_prompt = hide_code