Merge pull request #5159 from learningequality/0.16.x

0.16.6

data/version.yml

@@ -1,3 +1,37 @@
+0.16.6:
+  release_date: "2016/06/14"
+  git_commit: ""
+  new_features: []
+  bugs_fixed:
+    all:
+      - Content packs updated, bulk of broken exercises fixed and all languages rebuilt (and should be re-downloaded), pay attention to a couple of known issues!
+      - Allow logins during LOCKDOWN #5117
+      - Remove RPI warning message about max number of concurrent downloads, there's no longer a limit on small platforms #4982
+      - Make ROOT_DATA_PATH consider the KALITE_DIR environment variable #5143
+      - Restore downloading on RPI w/ m2crypto: Unbundle requests and use requests.get instead of urllib.urlretrieve #5138
+      - Docs: Add warning message on KA Lite windows application docs #5137
+      - Treat socket.error as if no server is running #5135 
+      - Docs: Connect to ka-lite on IRC #ka-lite (Freenode) - #5127 
+      - Notify student when all exercises in a series are completed (level has been mastered) #4875
+      - Use current year in parts of footer #5112
+      - Handle socket.error: Fix some cases where KA Lite fails to start due to a previous unclean shutdown #5132
+    students: []
+    coaches: []
+    admins: []
+
+
+0.16.5:
+  release_date: "2016/05/02"
+  git_commit: "cfcedf2"
+  new_features: []
+  bugs_fixed:
+    all:
+      - Missing fonts for some icons and math symbols #5110
+    students: []
+    coaches: []
+    admins: []
+
+
 0.16.4:
   release_date: "2016/04/29"
   git_commit: ""

docs/conf.py

@@ -15,6 +15,8 @@
 import sys
 import os
 
+from datetime import datetime
+
 # Will use pyvirtualdisplay if "true", but if unset or for any other value will not
 #os.environ['SPHINX_SS_USE_PVD'] = "true"
 
@@ -30,14 +32,15 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
+    'sphinx.ext.extlinks',
     'sphinx.ext.intersphinx',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
@@ -60,7 +63,7 @@
 
 # General information about the project.
 project = u'KA Lite'
-copyright = u'2015, FLE'
+copyright = u'%d, Learning Equality' % datetime.now().year
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -69,7 +72,7 @@
 # The short X.Y version.
 version = V.SHORTVERSION
 # The full version, including alpha/beta/rc tags.
-release = V.SHORTVERSION
+release = V.VERSION
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -110,8 +113,38 @@
 #keep_warnings = False
 
 
+# Markup to shorten external links
+# Now, you can use the alias name as a new role, e.g. :issue:`123`.
+#   - You can also use the usual “explicit title” syntax supported by other
+#     roles that generate links, i.e. :issue:`this issue <123>`. In this case,
+#     the prefix is not relevant.
+# sphinx.pocoo.org/ext/extlinks.html
+url_pantry_base = 'http://pantry.learningequality.org/downloads/ka-lite/{version:s}/'.format(version=str(version))
+
+url_redirect_download_base = "https://learningequality.org/r/"
+url_windows_installer = url_redirect_download_base + (
+    "windows-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_osx_installer = url_redirect_download_base + (
+    "osx-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_deb_installer = url_redirect_download_base + (
+    "deb-bundle-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+url_deb_pi_installer = url_redirect_download_base + (
+    "deb-pi-installer-%s-%s" % (V.MAJOR_VERSION, V.MINOR_VERSION)
+)
+
+extlinks = {
+    'url-issue': ('https://github.com/learningequality/ka-lite/issues/%s', '#'),
+    'url-pantry': (url_pantry_base + '%s', None),
+    'url-windows-installer': (url_windows_installer + '%s', None),
+    'url-osx-installer': (url_windows_installer + '%s', None),
+    'url-deb-installer': (url_windows_installer + '%s', None),
+    'url-deb-pi-installer': (url_windows_installer + '%s', None),
+}
+
 # -- Options for HTML output ----------------------------------------------
-import os
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
@@ -214,7 +247,7 @@
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
   ('index', 'KALite.tex', u'KA Lite Documentation',
-   u'FLE', 'manual'),
+   u'Learning Equality', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -244,7 +277,7 @@
 # (source start file, name, description, authors, manual section).
 man_pages = [
     ('index', 'kalite', u'KA Lite Documentation',
-     [u'FLE'], 1)
+     [u'Learning Equality'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -258,7 +291,7 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
   ('index', 'KALite', u'KA Lite Documentation',
-   u'FLE', 'KALite', 'One line description of project.',
+   u'Learning Equality', 'KALite', 'One line description of project.',
    'Miscellaneous'),
 ]
 
@@ -281,3 +314,12 @@
 # sphinx-intl options
 locale_dirs = ['locale/']
 gettext_compact = False
+
+
+rst_prolog = (
+    ".. |version_major| replace:: {version_major:s}\n"
+    ".. |version_minor| replace:: {version_minor:s}\n"
+).format(
+    version_major=V.MAJOR_VERSION,
+    version_minor=V.MINOR_VERSION,
+)

docs/faq.rst

@@ -49,12 +49,15 @@ I would like to download the videos for KA Lite via BitTorrent, is this possible
 
 Yes! Please see the instructions for ":ref:`bulk-video-downloads`".
 
+
+.. _content_pack_retrieve_offline:
+
 How can I install a language pack without a reliable internet connection?
 -------------------------------------------------------------------------
 
 In version 0.16 we changed the proces for making KA Lite available in other languages. For more technical background about the new **contentpacks**, please refer to our `Wiki page <https://github.com/learningequality/ka-lite/wiki/Content-packs>`_.
 
-You can download from our server the new `contentpacks for all the languages <http://pantry.learningequality.org/downloads/ka-lite/0.16/content/contentpacks/>`_, and carry around the zip file to computers you want to install the contentpack to.
+You can download from our server the new :url-pantry:`contentpacks for all the languages <content/contentpacks/>`, and carry around the zip file to computers you want to install the contentpack to.
 
 Once you have downloaded the contentpack for install on a computer without a reliable internet access, use the following command::
 

docs/installguide/advanced.rst

@@ -72,16 +72,18 @@ Portable tarballs / zip files with setup.py
 If you can't install KA Lite on systems with the standard Windows/Mac/Linux installers,
 you can fetch the KA Lite python package from `PyPi <https://pypi.python.org/pypi/ka-lite-static>`_.
 
-To unpack the package for installation, run::
+To unpack the package for installation, run:
 
-   $> tar -xf ka-lite-static-0.16.0.tar.gz
+.. parsed-literal::
+
+   $> tar -xf ka-lite-static-|release|.tar.gz
 
 Once it's unpacked, install it by entering the extracted directory and running::
 
     $> sudo python setup.py install.
 
 Beware that the PyPi sources do not contain assessment items, so you need to
-`download the contentpack en.zip manually <http://pantry.learningequality.org/downloads/ka-lite/0.16/content/contentpacks/en.zip>`_ (~650 MB).
+:url-pantry:`download the contentpack en.zip manually <content/contentpacks/en.zip>` (>700 MB)..
 
 
 Specific system setups

docs/installguide/install_all.rst

@@ -1,7 +1,7 @@
 Windows
 =======
 
-#. Download the KA Lite `Windows <https://learningequality.org/r/windows-installer-0-16>`_ installer.
+#. Download the KA Lite :url-windows-installer:`Windows installer <>`.
 #. Double-click the downloaded .exe file, and the wizard window will appear to guide you through the process of installing KA Lite on your server.
 
 Upgrade
@@ -44,13 +44,22 @@ For more advanced use of KA Lite, such as changing the default port, see :ref:`r
 or use the command-line ``kalite`` program, which in typical installations can be found at the path
 ``C:\Python27\Scripts\kalite``. Run ``kalite --help`` for usage info.
 
+.. warning::
+    If you need to download and install contentpacks locally for languages other
+    than English, make sure you are doing it
+    **as the same user that installed KA Lite** in the first place. If you
+    perform the contentpack installation as a different user, some content will
+    not load properly. For downloading and installing content packs for offline
+    methods and automatic deployments, see :ref:`content_pack_retrieve_offline`.
+
+
 Mac OS X
 ========
 
 Installation
 ____________
 
-#. Download the KA Lite `OSX installer <https://learningequality.org/r/osx-installer-0-16>`_.
+#. Download the KA Lite :url-osx-installer:`OSX installer <>`.
 #. After the download is complete, double click the .pkg file.
 #. Click on the Continue button to allow the installer program to check for pre-installation requirements.
 #. Follow the prompts in the installer dialog to install KA Lite.
@@ -64,7 +73,7 @@ _______
 
 To upgrade an existing KA Lite installation.
 
-#. Download the KA Lite `OSX installer <https://learningequality.org/r/osx-installer-0-16>`_.
+#. Download the KA Lite :url-osx-installer:`OSX installer <>`.
 #. Make sure that you stop the server and quit the KA Lite Monitor.
 #. After the download is complete, double click the .pkg file.
 #. Click on the Continue button to allow the installer program to check for pre-installation requirements.
@@ -82,7 +91,7 @@ Linux
 Main method: Ubuntu/Debian .deb
 _______________________________
 
-Download the `latest .deb <https://learningequality.org/r/deb-bundle-installer-0-16>`_ installer, and run this command::
+Download the :url-deb-installer:`latest .deb <>` installer, and run this command::
 
     sudo dpkg -i FILENAME.deb
 
@@ -132,14 +141,18 @@ Raspberry Pi
 ____________
 
 For a Raspberry Pi running a Debian system, you can install the special Debian
-package ``ka-lite-raspberry-pi`` (`Download .deb <https://learningequality.org/r/deb-pi-installer-0-16>`_).
+package ``ka-lite-raspberry-pi`` (:url-deb-pi-installer:`Download as .deb file <>`).
+
+To download and install it from command line:
 
-It can be installed by downloading the latest .deb on the Pi and installing it::
+.. parsed-literal::
 
     # Install dependencies
     sudo apt-get install python-m2crypto python-pkg-resources nginx python-psutil
+    
     # Fetch the latest .deb
-    sudo wget https://learningequality.org/r/deb-pi-installer-0-16 --no-check-certificate --content-disposition 
+    sudo wget https://learningequality.org/r/deb-pi-installer-|version_major|-|version_minor| --no-check-certificate --content-disposition 
+    
     # Install the .deb
     sudo dpkg -i ka-lite-raspberry-pi*.deb
 

docs/installguide/release_notes.rst

@@ -1,6 +1,70 @@
 Release Notes
 =============
 
+0.16.6
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Content packs updated, bulk of broken exercises fixed and all languages rebuilt (and should be re-downloaded), pay attention to a couple of known issues!
+ * Allow logins during LOCKDOWN :url-issue:`5117`
+ * Remove RPI warning message about max number of concurrent downloads, there's no longer a limit on small platforms :url-issue:`4982`
+ * Make ROOT_DATA_PATH consider the KALITE_DIR environment variable :url-issue:`5143`
+ * Restore downloading on RPI w/ m2crypto: Unbundle requests and use requests.get instead of urllib.urlretrieve :url-issue:`5138`
+ * Docs: Add warning message on KA Lite windows application docs :url-issue:`5137`
+ * Treat socket.error as if no server is running :url-issue:`5135` 
+ * Docs: Connect to ka-lite on IRC #ka-lite (Freenode) - :url-issue:`5127`
+ * Notify student when all exercises in a series are completed (level has been mastered) :url-issue:`4875`
+ * Use current year in parts of footer :url-issue:`5112`
+ * Handle socket.error: Fix some cases where KA Lite fails to start due to a previous unclean shutdown :url-issue:`5132`
+
+
+0.16.5
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Missing fonts for some icons and math symbols :url-issue:`5110`
+
+0.16.4
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Update Perseus JS modules resulting in many broken exercises :url-issue:`5105` :url-issue:`5036` :url-issue:`5099`
+ * Fix broken unpacking of legacy assessment items zip :url-issue:`5108`
+
+0.16.3
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Fix for 'nix based systems with unconventional kernel versioning :url-issue:`5087`
+
+0.16.2
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Fix attempt log filtering :url-issue:`5082`
+
+
+0.16.1
+------
+
+Bug fixes
+^^^^^^^^^
+
+ * Tweaks to our documentation :url-issue:`5067`
+ * Refactor assessment item asking logic in the setup command :url-issue:`5065`
+ * Properly copy over docs pages while preserving content pack assets :url-issue:`5074`
+
+
 0.16.0
 ------
 

docs/kalite-theme/breadcrumbs.html

@@ -26,3 +26,15 @@
   </ul>
   <hr/>
 </div>
+<style>
+  /* Style the literal block because it's missing styling */
+  pre.literal-block
+  {
+    padding: 12px 12px !important;
+    font-family: Consolas,"Andale Mono WT","Andale Mono","Lucida Console","Lucida Sans Typewriter","DejaVu Sans Mono","Bitstream Vera Sans Mono","Liberation Mono","Nimbus Mono L",Monaco,"Courier New",Courier,monospace;
+    font-size: 12px;
+    line-height: 1.5;
+    color: #404040;
+    overflow: auto;
+  }
+</style>

docs/usermanual/userman_admin.rst

@@ -465,7 +465,7 @@ __________________________
 
 The full set of videos, if downloaded through the KA Lite interface, will occupy more than 150GB.
 If you want to download all the videos, we also have torrent files with resized videos (~33 GB for English). To fetch all
-the videos, `download and open the appropriate torrent file <https://learningequality.org/downloads/ka-lite/0.16/content/>`_.
+the videos, :url-pantry:`download and open the appropriate torrent file <content/>`.
 
 Save the videos in the ``CONTENT_ROOT`` directory of your installation. By default, that
 is the ``.kalite/content/`` folder in the *home directory* of the user running KA Lite.
@@ -503,8 +503,6 @@ KA Lite content is offered in several languages. If your language is available y
 
 .. warning:: If you are upgrading from a previous KA Lite version, you **MUST** update all the languages you had previously **AND** restart your server. If you are unsure on how to do this, please see :ref:`restarting-your-server`.
 
-.. note:: If you are working on a fresh installation of version 0.16, you do not need to restart the server after downloading **contentpacks** in other languages.
-
 
 Download Language Packs
 _______________________

kalite/__init__.py

@@ -7,4 +7,7 @@
 __version__ = VERSION
 
 # ROOT_DATA_PATH is *not* where the source files live. It's a place where non-user-writable data files may be written.
-ROOT_DATA_PATH = os.path.join(sys.prefix, 'share', 'kalite')
+if 'KALITE_DIR' in os.environ:
+    ROOT_DATA_PATH = os.environ['KALITE_DIR']
+else:
+    ROOT_DATA_PATH = os.path.join(sys.prefix, 'share', 'kalite')