Control included JavaScript in templates

AA-Turner · AA-Turner · commit 826d59b809bf · 2021-06-09T00:30:48.000+01:00
diff --git a/pep_sphinx_extensions/__init__.py b/pep_sphinx_extensions/__init__.py
@@ -19,27 +19,16 @@
 }
 
 
-# Monkeypatch StandaloneHTMLBuilder to not include JS libraries (underscore.js & jQuery)
-def init_less_js(self: sphinx.builders.html.StandaloneHTMLBuilder) -> None:
-    js_files = [
-        ("js/doctools.js", {}),
-        ("language_data.js", {}),
-        *self.app.registry.js_files,
-        *self.get_builder_config("js_files", default="html")
-    ]
-    for filename, attrs in js_files:
-        self.add_js_file(filename, **attrs)
-
-
+# Monkeypatch StandaloneHTMLBuilder to whitelist child theme files only
 def copy_theme_static_override(self: sphinx.builders.html.StandaloneHTMLBuilder, _: dict) -> None:
+    """Include all files from theme/static except the templates folder."""
     if self.theme:
         source = pathlib.Path(self.theme.themedir, "static")
         dest = pathlib.Path(self.outdir, "_static")
         shutil.copytree(source, dest, dirs_exist_ok=True)
         shutil.rmtree(dest / "templates", ignore_errors=True)
 
 
-sphinx.builders.html.StandaloneHTMLBuilder.init_js_files = init_less_js
 sphinx.builders.html.StandaloneHTMLBuilder.copy_theme_static_files = copy_theme_static_override
 # Cache pygments formatters
 sphinx.highlighting.PygmentsBridge.get_formatter = functools.cache(sphinx.highlighting.PygmentsBridge.get_formatter)
diff --git a/pep_sphinx_extensions/theme/static/templates/layout.html b/pep_sphinx_extensions/theme/static/templates/layout.html
@@ -14,6 +14,10 @@
     <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
 {%- endblock %}
 
+{%- block scripts %}
+    <script src="{{ pathto('_static/js/doctools.js', 1) }}"></script>
+{%- endblock %}
+
 {%- block body_tag %}<body class="python pages pep-page">{% endblock %}
 {%- block header %}<header style="height: 219px; background-color: #2b5b84;"></header>{% endblock %}
 {%- block relbar1 %}{% endblock %}
