Consolidate template related path/name config options in conf.tmpl, improve documentation

Author: ascholerChemeketa

runestone/common/project_template/conf.tmpl

@@ -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,11 +207,17 @@ 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"]
@@ -226,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'
@@ -251,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