Merge pull request #1233 from ascholerChemeketa/theme_override_cleanup

Theme override cleanup

Author: bnmnetp

README.rst

@@ -162,7 +162,7 @@ Our goal is to have unit tests which rely on Selenium (a library that helps simu
 
 **To run tests:**
 
-* Make sure the directory containing the PhantomJS executable is in your ``PATH`` environment variable. e.g. ``PATH=$PATH:path/to/virtualenv/directory/where/it/is/here`` at your command line (or edit your ``.bash_profile``). It should live in the site-packages/selenium/webdriver/ directory of your virtualenv.
+* Make sure the directory containing the ChromeDriver executable is in your ``PATH`` environment variable. e.g. ``PATH=$PATH:path/to/chromedriver`` at your command line (or edit your ``.bash_profile``).
 
 * Check out the existing tests, e.g. the ``test_question.py`` file that tests the Question directive, which you can find at the path ``/runestone/question/test/test_question.py``, for an example.
 

runestone/__init__.py

@@ -48,7 +48,7 @@ def runestone_static_dirs():
     module_static_js.append(os.path.join(basedir, "codelens", "js"))
     module_static_js.append(os.path.join(basedir, "webgldemo", "js"))
     module_static_js.append(os.path.join(basedir, "matrixeq", "js"))
-    module_static_css = [os.path.join(basedir, "common", "css", "sphinx")]
+    module_static_css = []
     module_static_css.append(os.path.join(basedir, "accessibility", "css"))
     module_static_css.append(os.path.join(basedir, "webgldemo", "css"))
     module_static_css.append(os.path.join(basedir, "matrixeq", "css"))
@@ -145,7 +145,12 @@ def setup(app):
         print("No custom CSS files")
     try:
         for c in setup.custom_js_files:
-            app.add_js_file(c)
+            if isinstance(c, dict):
+                #peel off filename, pass rest of key/values on as kwargs
+                filename = c.pop("file") 
+                app.add_autoversioned_javascript(filename, **c)
+            else:
+                app.add_autoversioned_javascript(c)
         print("Adding custom Javascript")
     except AttributeError:
         print("No custom js files")
@@ -225,8 +230,6 @@ def build(options):
 css_files = [
     # Generated from a template, so it can't be directly included in the webpack.
     "bootstrap-sphinx.css",
-    # Deliberately excluded, so it can be overridden by a user-supplied CSs file.
-    "theme-overrides.css",
 ]
 
 

runestone/common/css/sphinx/theme-overrides.css

@@ -84,16 +84,14 @@ Now feel free to modify this file to start creating your own interactive page.
 Section 4: Theme
 :::::::::::::::::::
 
-You can override the style rules in the default theme by adding css rules to a file named **theme-overrides.css** (the filename is important - this will replace an existing file). Make sure the file's directory is part of the ``html_static_path``. You can do so by placing it in a folder **_static**, then modifying ``html_static_path`` in conf.py to include that folder:
-
-.. code:: 
-
-    html_static_path =  runestone_static_dirs() + ['_static']
+You can add your own CSS or JS files to every page of a book by modifying ``setup.custom_css_files`` or ``setup.custom_js_files`` in conf.py.
 
+If you want to do more significant changes to the theme, you should copy the files you wish to modify from
+the runestone/common/project/template/sphinx_bootstrap to a directory like ``_templates/``. Then make sure
+the ``templates_path`` points to them in your conf.py.
 
-If you want to do more significant changes to the theme, you should copy the files in the runestone/common/project/template/sphinx_bootstrap to a directory like ``_templates/my_theme``. Then make sure these values are set in conf.py:
+conf.py:
 
 .. code:: 
 
-    html_theme_path = ["_templates"]
-    html_theme = 'my_theme'
+    templates_path = ["_templates"]

runestone/common/project_template/_sources/index.rst

@@ -334,9 +334,9 @@
     <p>
     {%- if show_copyright %}
       {%- if hasdoc('copyright') %}
-        {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
+        {% trans path=pathto('copyright'), copyright=copyright %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
       {%- else %}
-        {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
+        {% trans copyright=copyright %}&copy; Copyright {{ copyright }}.{% endtrans %}
       {%- endif %}
     {%- endif %}
     {%- if last_updated %}

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

@@ -34,10 +34,6 @@ extensions = ['sphinx.ext.mathjax'] + runestone_extensions()
 
 #,'runestone.video','runestone.reveal','runestone.poll','runestone.tabbedStuff','runestone.disqus','runestone.codelens','runestone.activecode', 'runestone.assess', 'runestone.animation','runestone.meta', 'runestone.parsons', 'runestone.blockly', 'runestone.livecode','runestone.accessibility']
 
-# This sets up your project to use the defaults.  If you want to create a custom  set of templates
-# for your own project you can over ride them by creating your own _templates folder
-templates_path = [pkg_resources.resource_filename('runestone', 'common/project_template/_templates')]
-
 # The suffix of source filenames.
 source_suffix = '.rst'
 
@@ -154,14 +150,22 @@ inline_highlight_literals = False
 
 # -- Options for HTML output ---------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
+# The theme to use for HTML and HTML Help pages. sphinx_bootstrap is provided with
+# Runestone. Other themes are built into sphinx:
+# https://www.sphinx-doc.org/en/master/usage/theming.html?highlight=html_theme_path#using-a-theme
 html_theme = 'sphinx_bootstrap'
 
+# If using a non-sphinx theme, the path to the theme folder must be in this list
+html_theme_path = [pkg_resources.resource_filename('runestone', 'common/project_template/_templates/plugin_layouts')]
+
+# To override individual templates from the theme, you can make a directory and add its path
+# relative to this file to the templates_path list. In it, place copies of any template files
+# you wish to override - your template file(s) will be used instead of the default ones from the theme
+#templates_path = ['_templates']
+
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {'nosidebar': 'true'}
 html_theme_options = {
     # Navigation bar title. (Default: ``project`` value)
     'navbar_title': "%(project_title)s",
@@ -203,12 +207,27 @@ html_theme_options = {
     #'bootswatch_theme': "slate",
 }
 
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+# https://www.sphinx-doc.org/en/master/usage/configuration.html?highlight=html_sidebars#confval-html_additional_pages
+#html_additional_pages = {}
+
+# A list of paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# Example: html_static_path =  runestone_static_dirs() + ['_static', 'other']
+html_static_path = runestone_static_dirs()
 
-# This is set up to use the default runestone themes, you can override them by
-# creating your own folder and modifying this path.
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [pkg_resources.resource_filename('runestone', 'common/project_template/_templates/plugin_layouts')]
+# List of extra stylesheets that should be added to all html pages
+# Files must be on a path contained in html_static_path
+#setup.custom_css_files = ["sample.css", "sample2.css"]
 
+# List of extra js files that should be added to all html pages
+# Items may be a file name or a dict with properties {"file":FILENAME, "key1", "value1", "key2, "value2"...}
+#   in which case file should have the file name and other key/value pairs are used as attrs
+#   on the script tag. The sample below will set sample2.js's script tag to have the defer attr
+# Files must be on a path contained in html_static_path
+#setup.custom_js_files = ["sample.css", {"file": "sample2.js", "defer": ""}]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -217,23 +236,14 @@ html_title = 'Runestone Interactive Overview'
 # A shorter title for the navigation bar.  Default is the same as html_title.
 html_short_title ='Runestone Interactive Overview'
 
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-
-# logo is included in layout file
+# Logo is included at the top of the page
 #html_logo = "../source/_static/logo_small.png"
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #html_favicon = None
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-
-html_static_path = runestone_static_dirs()
-
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 #html_last_updated_fmt = '%%b %%d, %%Y'
@@ -242,13 +252,6 @@ html_static_path = runestone_static_dirs()
 # typographically correct entities.
 #html_use_smartypants = True
 
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
 # If false, no module index is generated.
 #html_domain_indices = True
 

runestone/common/project_template/conf.tmpl

@@ -24,7 +24,7 @@ module.exports = (env, argv) => {
             rules: [
                 {
                     test: /\.css$/i,
-                    use: [argv.mode === "development" ? "style-loader" : MiniCssExtractPlugin.loader, "css-loader"],
+                    use: [MiniCssExtractPlugin.loader, "css-loader"],
                 },
                 {
                     test: /\.(png|jpe?g|gif|svg|eot|ttf|woff|woff2)$/i,