Merge branch 'master' into accessibility_fixes

Author: bnmnetp

.gitattributes

@@ -0,0 +1,2 @@
+# Declare files that must always have LF line endings on checkout so docker compose works on Windows
+*   eol=lf

conf.py

@@ -319,6 +319,12 @@
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 # html_file_suffix = None
 
+# It True, sets js files from Sphinx & Runestone to be loaded with defer attr
+# substantially speeding up page rendering. May cause issues with books that
+# have custom directives or raw html that assume jquery or another library
+# is loaded before body is parsed. 
+html_defer_js = True
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = "PythonCoursewareProjectdoc"
 

runestone/__init__.py

@@ -30,6 +30,7 @@
 import os, socket, pkg_resources
 import CodeChat.CodeToRest
 from sphinx.errors import ExtensionError
+from sphinx.builders.html import JavaScript
 
 
 # TODO: clean up - many of the folders are not needed as the files are imported by webpack
@@ -75,6 +76,26 @@ def runestone_extensions():
     modules.insert(0, modules.pop(modules.index("runestone.common")))
     return modules
 
+# setup_js_defer(app, pagename, templatexname, context, doctree)
+# -----------------------
+# Used to inspect js right before it is rendered to page so that
+# we can forcibly defer js files or prevent same
+def setup_js_defer(app, pagename, templatexname, context, doctree):
+    def js_defer(script_files):
+        for js in sorted(script_files):
+            if app.config.html_defer_js:
+                # Files added from Runestone should already have defer set - so just add it to sphinx based ones
+                to_defer = ["_static/jquery.js", "_static/underscore.js","_static/doctools.js"]
+                if isinstance(js, JavaScript) and js in to_defer:
+                    js.attributes["defer"] = ""
+            else:
+                #config flag not set, prevent all deferrals
+                if isinstance(js, JavaScript):
+                    js.attributes.pop("defer", None)
+        return ''
+
+    context['js_defer'] = js_defer
+
 
 # setup(app)
 # ----------
@@ -94,16 +115,18 @@ def setup(app):
 
     for jsfile in script_files:
         try:
-            app.add_autoversioned_javascript(jsfile)
+            app.add_autoversioned_javascript(jsfile, defer="")
         except ExtensionError:
-            app.add_js_file(jsfile)
+            app.add_js_file(jsfile, defer="")
     for cssfile in _css_files:
         try:
             app.add_autoversioned_stylesheet(cssfile)
         except ExtensionError:
             app.add_css_file(cssfile)
 
     app.config.html_static_path.append("dist/")
+    app.add_config_value("html_defer_js", False, 'env')
+    app.connect('html-page-context', setup_js_defer)
 
 
 def get_master_url():

runestone/animation/animation.py

@@ -25,7 +25,7 @@
 
 def setup(app):
     app.add_directive("animation", Animation)
-    app.add_autoversioned_javascript("animationbase.js")
+    app.add_autoversioned_javascript("animationbase.js", defer="")
 
 
 SRC = """

runestone/animation/chart.html

@@ -18,7 +18,8 @@
 //	$("#visualization").gchart({type: 'graphviz', series: [$.gchart.series([20, 50, 30])]});
 // label: '<f0> left | <f1> middle | <f2> right'
 
-$('#visualization').gchart($.gchart.graphviz(true, 
+document.addEventListener('load', (event) => {
+$('#visualization').gchart($.gchart.graphviz(true,
  {
  struct1: {label: '<f0> left |<f1> middle |<f2> right'},
  struct2: {label: '<f0> one|<f1> two'},
@@ -32,6 +33,7 @@
                 node: {shape: 'record'}
         }
 ));
+});
 
 
 // $('#visualization').gchart($.gchart.graphviz(true, 

runestone/animation/jqchart/gChartBasic.html

@@ -8,7 +8,8 @@
 </style>
 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.1/jquery.min.js"></script>
 <script type="text/javascript" src="jquery.gchart.js"></script>
-<script type="text/javascript">
+<script>
+document.addEventListener('load', (event) => {
 $(function () {
 	$('#basicGChart').gchart({type: 'line', maxValue: 40,
 		title: 'Weather for|Brisbane, Australia', titleColor: 'green',
@@ -27,6 +28,7 @@
 		$.gchart.axis('right', ['mm'], [50], 'blue', 'left')],
 		legend: 'right'});
 });
+});
 </script>
 </head>
 <body>

runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/layout.html

@@ -16,6 +16,12 @@
 <!DOCTYPE html>
 {%- endblock %}
 
+{%- block scripts %}
+{# Override the scripts block from sphinx so we can force loading of jquery/underscore/doctools js files #}
+{{ js_defer(script_files) }}
+{{ super() }}
+{%- endblock %}
+
 {# Sidebar: Rework into our Boostrap nav section. #}
 {% macro navBar() %}
 
@@ -386,6 +392,10 @@
   {% endif %}
 {% endif %}
 
-<script> runestoneComponents.getSwitch(); </script>
+<script> 
+  document.addEventListener('load', (event) => {
+    runestoneComponents.getSwitch(); 
+  });
+</script>
 
 {% endblock %}

runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/relations.html

@@ -25,6 +25,8 @@
           'delay': { show: 100, hide: 50}
          };
 
-  $('#relations-prev').tooltip(opts);
-  $('#relations-next').tooltip(opts);
+  document.addEventListener('load', (event) => {
+    $('#relations-prev').tooltip(opts);
+    $('#relations-next').tooltip(opts);
+  });
 </script>

runestone/common/project_template/_templates/plugin_layouts/sphinx_bootstrap/subchapter.html

@@ -25,10 +25,10 @@
 {%- endif %}
 
 <script type="text/javascript">
-
+document.addEventListener('load', (event) => {
   $('#relations-prev').tooltip({'placement':'right', 'selector': '', 'delay': { show: 100, hide: 50}});
   $('#relations-next').tooltip({'placement':'left', 'selector': '', 'delay': { show: 100, hide: 50}});
-
+});
 </script>
 
 <script>

runestone/common/project_template/conf.tmpl

@@ -275,6 +275,12 @@ html_show_sourcelink = False
 # This is the file name suffix for HTML files (e.g. ".xhtml").
 #html_file_suffix = None
 
+# It True, sets js files from Sphinx & Runestone to be loaded with defer attr
+# substantially speeding up page rendering. May cause issues with books that
+# have custom directives or raw html that assume jquery or another library
+# is loaded before body is parsed. 
+html_defer_js = True
+
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'PythonCoursewareProjectdoc'