merge

Author: runestonetest

CONTRIBUTING.rst

@@ -3,25 +3,26 @@ Contributing to the Runestone Components
 
 We welcome contributions large and small to the Runestone Components.  We welcome contributions from newcomers as well as seasoned Runestone hackers.  You don't need to be an expert to make a contribution here.  When I started this project I had barely written a line of Javascript, Runestone is a project that is all about helping people learn, if you learn by helping us improve Runestone that is even better!
 
-Understand the RoadMap
-----------------------
+Understand the Road map
+-----------------------
 
-You should look at the `development road map <https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap>`_
-and especially RSE-0001 which gives you a clear idea of the current philosophy behind the components.  Any
+You should look at the `development road map <https://github.com/bnmnetp/runestone/wiki/DevelopmentRoadmap2019>`_
+and especially `RSE-0001 <https://github.com/RunestoneInteractive/RunestoneServer/wiki/RSE-0001>`_ which gives you a clear idea of the current philosophy behind the components.  Any
 Sphinx directives should create very simple html and let Javascript take care of the rest.
 
 Coding Standards
 ----------------
 
 *   All components must be Python 3 compatible.   The ``six`` module is already
     in the requirements.txt file, so feel free to use that.
-*   No Tabs for Python files (4 spaces = 1 indention)
-*   Avoid profliferation of jQuery versions.  Make your stuff compatible with the version
+*   No Tabs for Python files (4 spaces = 1 indentation)
+*   Avoid proliferation of jQuery versions.  Make your stuff compatible with the version
     of jQuery in the common folder.
 *   Avoid proliferation of additional third party javascript modules.  We are already out of
     control in this regard and it would be nice to rein it in.
+*   To add JavaScript for a new component, follow the directions in `webpack.index.js` for dynamically-loaded components.
 *   When creating a new directive, assign a unique class name to the outermost HTML division. That will allow you to easily confine your CSS declarations to apply only within your directive. Since there are many directives, chances for CSS namespace conflicts are high without that.
-*   When making a new directive Also put the outer div in the runestone class, this makes it easy for us to select all runestone components on a page.
+*   When making a new directive, also put the outer div in the runestone class. This makes it easy for us to select all runestone components on a page.
 *   When making any changes, make sure the docstring for the class that implements the Sphinx directive is up to date.  These docstrings are used in several places for templates and quick help.
 *   Make sure your new directive class inherits and uses RunestoneBase
 *   Avoid writing a directive that returns a raw node.  Creating appropriate nodes that inherit from Runestone gives us much more flexibility to auto number and cross reference and store source in the database.
@@ -46,17 +47,17 @@ multiple instances of your component on a single web page.
 Internationalization
 --------------------
 
-It is recomended to implement internationalization as described in `I18N` even if you plan to support only English currently. Besides making easy to support other languages in the future, internationalization helps you to better separate natural language text fragments from the rest of your code.
+It is recommended to implement internationalization as described in `I18N` even if you plan to support only English currently. Besides making easy to support other languages in the future, internationalization helps you to better separate natural language text fragments from the rest of your code.
 
 
 Major Feature Contributions
 ===========================
 
-There are many ways that we can continue to improve and make the Runestone platform great, and I am exctied to see the platform evolve.  What I would ask is that if you have a large new feature that you would like to propose / contribute please start by creating an issue.  This will allow us to discuss it together up front, consider the design implications, and make it more likely that the PR will be accepted with a minimum of fuss.
+There are many ways that we can continue to improve and make the Runestone platform great, and I am exited to see the platform evolve.  What I would ask is that if you have a large new feature that you would like to propose / contribute please start by creating an issue.  This will allow us to discuss it together up front, consider the design implications, and make it more likely that the PR will be accepted with a minimum of fuss.
 
-Runestone has grown organically over the years but that has led to duplicated tables in the database duplicated code and lots of inconsistency.  We need to start working to change all of that if we are going to continue to grow runestone efficiently.
+Runestone has grown organically over the years but that has led to duplicated tables in the database duplicated code and lots of inconsistency.  We need to start working to change all of that if we are going to continue to grow Runestone efficiently.
 
 
 JavaScript
 ----------
-All the JavaScript files in the Runestone Components are analzyed by webpack. If you add or remove JavaScript files, update the `webpack.index.js`.
+All the JavaScript files in the Runestone Components are analyzed by webpack. If you add or remove JavaScript files, update the `webpack.index.js`.

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.
 

codechat_config.json

@@ -0,0 +1,39 @@
+# .. Copyright (C) 2012-2020 Bryan A. Jones.
+#
+#  This file is part of the CodeChat System.
+#
+#  The CodeChat System is free software: you can redistribute it and/or
+#  modify it under the terms of the GNU General Public License as
+#  published by the Free Software Foundation, either version 3 of the
+#  License, or (at your option) any later version.
+#
+#  The CodeChat System is distributed in the hope that it will be
+#  useful, but WITHOUT ANY WARRANTY; without even the implied warranty
+#  of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with the CodeChat System.  If not, see
+#  <http://www.gnu.org/licenses/>.
+#
+# ************************************************
+# |docname| - Configuration for a CodeChat project
+# ************************************************
+# This file defines the configuration for a CodeChat project. It contains a working `Sphinx <https://www.sphinx-doc.org/>`_ configuration.
+#
+# ``source_path``: optional; defaults to ``.`` (the current directory). A path to the root of the source tree. Relative paths are rooted in the directory containing this configuration file.
+source_path: .
+
+# ``output_path``: required. A path to the root of the HTML output produced by this renderer. Relative paths are rooted in the directory containing this configuration file.
+output_path: build/RunestoneComponents
+
+# ``args``: required string or sequence of strings. This provides the arguments to invoke the renderer. These strings may optionally contain the following replacement values:
+#
+# - ``{project_path}``: an absolute path to the directory containing this file.
+# - ``{source_path}``: the ``source_path`` above, but as an absolute path.
+# - ``{output_path}``: the ``output_path`` above, but as an absolute path.
+#
+args: runestone build
+
+# ``html_ext``: optional; defaults to ``.html``. The extension used by this renderer when generating HTML files.
+#html_ext: .html

codechat_config.yaml

@@ -32,7 +32,7 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     "sphinx.ext.mathjax",
-    "recommonmark",
+    "myst_parser",
     "sphinx.ext.intersphinx",
 ] + runestone_extensions()
 
@@ -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"
 

conf.py

@@ -46,10 +46,9 @@ Misc
     ACKNOWLEDGEMENTS
     .github/FUNDING.yml
     .gitignore
-    .travis.yml
     .readthedocs.yml
     conf.py
-    codechat_config.json
+    codechat_config.yaml
     requirements-dev.in
     requirements.in
     webpack.config.js