Update templates to conform to new nbconvert system

jupyter · Mar 18, 2021 · caec1e6 · caec1e6
1 parent eaf55f0
commit caec1e6
Show file tree

Hide file tree

Showing 23 changed files with 39 additions and 75 deletions.
diff --git a/nbgrader/converters/generate_feedback.py b/nbgrader/converters/generate_feedback.py
@@ -55,9 +55,8 @@ def _load_config(self, cfg, **kwargs):
     def __init__(self, coursedir=None, **kwargs):
         super(GenerateFeedback, self).__init__(coursedir=coursedir, **kwargs)
         c = Config()
-        if 'template_file' not in self.config.HTMLExporter:
-            c.HTMLExporter.template_file = 'feedback.html.j2'
-        if 'template_path' not in self.config.HTMLExporter:
-            template_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'server_extensions', 'formgrader', 'templates'))
-            c.HTMLExporter.template_paths.extend(['.', template_path])
+        c.HTMLExporter.template_name = 'feedback'
+        c.HTMLExporter.template_file = 'feedback.html.j2'
+        template_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', 'server_extensions', 'formgrader', 'templates'))
+        c.HTMLExporter.extra_template_basedirs.append(template_path)
         self.update_config(c)
diff --git a/nbgrader/preprocessors/getgrades.py b/nbgrader/preprocessors/getgrades.py
@@ -42,6 +42,9 @@ def preprocess(self,
             resources['nbgrader']['max_score'] = notebook.max_score
             resources['nbgrader']['late_penalty'] = late_penalty
 
+        # Set title
+        nb['metadata']['title'] = resources['nbgrader']['notebook']
+
         return nb, resources
 
     def _get_comment(self, cell: NotebookNode, resources: ResourcesDict) -> None:

diff --git a/nbgrader/server_extensions/formgrader/base.py b/nbgrader/server_extensions/formgrader/base.py
@@ -62,19 +62,19 @@ def render(self, name, **ns):
     def write_error(self, status_code, **kwargs):
         if status_code == 500:
             html = self.render(
-                'base_500.html.j2',
+                'pages/base_500.html.j2',
                 base_url=self.base_url,
                 error_code=500)
 
         elif status_code == 502:
             html = self.render(
-                'base_500.html.j2',
+                'pages/base_500.html.j2',
                 base_url=self.base_url,
                 error_code=502)
 
         elif status_code == 403:
             html = self.render(
-                'base_403.html.j2',
+                'pages/base_403.html.j2',
                 base_url=self.base_url,
                 error_code=403)
 

diff --git a/nbgrader/server_extensions/formgrader/formgrader.py b/nbgrader/server_extensions/formgrader/formgrader.py
@@ -25,13 +25,17 @@ def _classes_default(self):
 
     def build_extra_config(self):
         extra_config = super(FormgradeExtension, self).build_extra_config()
-        extra_config.HTMLExporter.template_file = 'formgrade'
-        extra_config.HTMLExporter.template_paths.append(handlers.template_path)
+        extra_config.HTMLExporter.template_name = 'formgrade'
+        extra_config.HTMLExporter.template_file = 'formgrade.html.j2'
+        extra_config.HTMLExporter.extra_template_basedirs.append(handlers.template_path)
         return extra_config
 
     def init_tornado_settings(self, webapp):
         # Init jinja environment
-        jinja_env = Environment(loader=FileSystemLoader([handlers.template_path]))
+        jinja_env = Environment(loader=FileSystemLoader([
+            os.path.join(handlers.template_path, 'formgrade'),
+            os.path.join(handlers.template_path, 'pages')
+        ]))
 
         course_dir = self.coursedir.root
         notebook_dir = self.parent.notebook_dir

diff --git a/nbgrader/server_extensions/formgrader/templates/feedback/conf.json b/nbgrader/server_extensions/formgrader/templates/feedback/conf.json
@@ -0,0 +1,7 @@
+{
+    "base_template": "classic",
+    "mimetypes": {
+        "text/html": true
+    },
+    "preprocessors": {}
+}
diff --git a/...ons/formgrader/templates/feedback.html.j2 → ...rader/templates/feedback/feedback.html.j2 b/...ons/formgrader/templates/feedback.html.j2 → ...rader/templates/feedback/feedback.html.j2
@@ -1,60 +1,12 @@
-{%- extends 'classic/index.html.j2' -%}
+{%- extends 'index.html.j2' -%}
 {% from 'mathjax.html.j2' import mathjax %}
 
-{%- block header -%}
-<!DOCTYPE html>
-<html>
-<head>
-
-<meta charset="utf-8" />
-<title>{{ resources.nbgrader.notebook }}</title>
-
-{% for css in resources.inlining.css -%}
-    <style type="text/css">
-    {{ css }}
-    </style>
-{% endfor %}
-
-<!-- Loading mathjax macro -->
-{{ mathjax() }}
-
-<style>
-td.center, th.center {
-    text-align: center;
-}
-
-body {
-  overflow: visible;
-  font-size: 14px;
-  padding-top: 1em;
-}
-
-div#notebook {
-  overflow: visible;
-  border-top: none;
-}
-
+{%- block html_head_css -%}
+<style type="text/css">
 div#notebook-container {
   width: 100%;
-}
-
-@media print {
-  div.cell {
-    display: block;
-    page-break-inside: avoid;
-  }
-  div.output_wrapper {
-    display: block;
-    page-break-inside: avoid;
-  }
-  div.output {
-    display: block;
-    page-break-inside: avoid;
-  }
-}
-
-div.prompt {
-  min-width: 21ex;
+  -webkit-box-shadow: none;
+  box-shadow: none;
 }
 
 div.nbgrader_cell {
@@ -105,9 +57,8 @@ span.nbgrader-label {
     top: 4px;
 }
 </style>
+{% endblock html_head_css %}
 
-</head>
-{%- endblock header -%}
 
 {% block body %}
 <body>
@@ -139,20 +90,13 @@ span.nbgrader-label {
         </div>
       </div>
       <div class="panel-body">
-        <div id="notebook" class="border-box-sizing">
-          <div class="container" id="notebook-container">
-            {{ super() }}
-          </div>
-        </div>
+        {{ super() }}
       </div>
     </div>
   </div>
 </body>
 {%- endblock body %}
 
-{% block footer %}
-</html>
-{% endblock footer %}
 
 {% macro score(cell) -%}
   <span class="pull-right">

diff --git a/nbgrader/server_extensions/formgrader/templates/formgrade/conf.json b/nbgrader/server_extensions/formgrader/templates/formgrade/conf.json
@@ -0,0 +1,7 @@
+{
+    "base_template": "classic",
+    "mimetypes": {
+        "text/html": true
+    },
+    "preprocessors": {}
+}
diff --git a/...ns/formgrader/templates/formgrade.html.j2 → ...der/templates/formgrade/formgrade.html.j2 b/...ns/formgrader/templates/formgrade.html.j2 → ...der/templates/formgrade/formgrade.html.j2
@@ -1,4 +1,4 @@
-{%- extends 'classic/index.html.j2' -%}
+{%- extends 'index.html.j2' -%}
 {% from 'formgrade_macros.html.j2' import nav, header %}
 {% from 'mathjax.html.j2' import mathjax %}
 

diff --git a/...ormgrader/templates/formgrade_404.html.j2 → ...templates/formgrade/formgrade_404.html.j2 b/...ormgrader/templates/formgrade_404.html.j2 → ...templates/formgrade/formgrade_404.html.j2
diff --git a/...grader/templates/formgrade_macros.html.j2 → ...plates/formgrade/formgrade_macros.html.j2 b/...grader/templates/formgrade_macros.html.j2 → ...plates/formgrade/formgrade_macros.html.j2
diff --git a/...ensions/formgrader/templates/base.html.j2 → ...s/formgrader/templates/pages/base.html.j2 b/...ensions/formgrader/templates/base.html.j2 → ...s/formgrader/templates/pages/base.html.j2
diff --git a/...ons/formgrader/templates/base_403.html.j2 → ...rmgrader/templates/pages/base_403.html.j2 b/...ons/formgrader/templates/base_403.html.j2 → ...rmgrader/templates/pages/base_403.html.j2
diff --git a/...ons/formgrader/templates/base_500.html.j2 → ...rmgrader/templates/pages/base_500.html.j2 b/...ons/formgrader/templates/base_500.html.j2 → ...rmgrader/templates/pages/base_500.html.j2
diff --git a/...r/templates/gradebook_assignments.html.j2 → ...lates/pages/gradebook_assignments.html.j2 b/...r/templates/gradebook_assignments.html.j2 → ...lates/pages/gradebook_assignments.html.j2
diff --git a/...rmgrader/templates/gradebook_base.html.j2 → ...er/templates/pages/gradebook_base.html.j2 b/...rmgrader/templates/gradebook_base.html.j2 → ...er/templates/pages/gradebook_base.html.j2
diff --git a/...es/gradebook_notebook_submissions.html.j2 → ...es/gradebook_notebook_submissions.html.j2 b/...es/gradebook_notebook_submissions.html.j2 → ...es/gradebook_notebook_submissions.html.j2
diff --git a/...der/templates/gradebook_notebooks.html.j2 → ...mplates/pages/gradebook_notebooks.html.j2 b/...der/templates/gradebook_notebooks.html.j2 → ...mplates/pages/gradebook_notebooks.html.j2
diff --git a/...ader/templates/manage_assignments.html.j2 → ...emplates/pages/manage_assignments.html.j2 b/...ader/templates/manage_assignments.html.j2 → ...emplates/pages/manage_assignments.html.j2
diff --git a/...mgrader/templates/manage_students.html.j2 → ...r/templates/pages/manage_students.html.j2 b/...mgrader/templates/manage_students.html.j2 → ...r/templates/pages/manage_students.html.j2
diff --git a/...lates/manage_students_assignments.html.j2 → ...pages/manage_students_assignments.html.j2 b/...lates/manage_students_assignments.html.j2 → ...pages/manage_students_assignments.html.j2
diff --git a/...er/templates/manage_students_base.html.j2 → ...plates/pages/manage_students_base.html.j2 b/...er/templates/manage_students_base.html.j2 → ...plates/pages/manage_students_base.html.j2
diff --git a/...age_students_notebook_submissions.html.j2 → ...age_students_notebook_submissions.html.j2 b/...age_students_notebook_submissions.html.j2 → ...age_students_notebook_submissions.html.j2
diff --git a/...ader/templates/manage_submissions.html.j2 → ...emplates/pages/manage_submissions.html.j2 b/...ader/templates/manage_submissions.html.j2 → ...emplates/pages/manage_submissions.html.j2