Browse Source

sphinx: conf: include CSS/JS files, the proper way

html_css_files and html_js_files exist since Sphinx 1.8, and it's the
proper (documented) mechanism to include custom CSS and JS files in
the documentation.

(From yocto-docs rev: 4ae9c426654e33fed4185e5d6e0de76b4a430d84)

Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Nicolas Dechesne 4 years ago
parent
commit
e4b904b21c
2 changed files with 4 additions and 5 deletions
  1. 0 2
      documentation/_templates/layout.html
  2. 4 3
      documentation/conf.py

+ 0 - 2
documentation/_templates/layout.html

@@ -1,7 +1,5 @@
 {% extends "!layout.html" %}
 
-{% set script_files = script_files + ['_static/switchers.js'] %}
-
 {% block extrabody %}
 <div id="outdated-warning" style="text-align: center; background-color: #FFBABA; color: #6A0E0E;">
 </div>

+ 4 - 3
documentation/conf.py

@@ -103,12 +103,13 @@ html_logo = 'sphinx-static/YoctoProject_Logo_RGB.jpg'
 html_static_path = ['sphinx-static']
 
 html_context = {
-    'css_files': [
-        '_static/theme_overrides.css',
-    ],
     'current_version': current_version,
 }
 
+# Add customm CSS and JS files
+html_css_files = ['theme_overrides.css']
+html_js_files = ['switchers.js']
+
 # Hide 'Created using Sphinx' text
 html_show_sphinx = False