From 96032f7ec1a65826f011baaae57e589ddbd00381 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Fri, 24 Jul 2015 18:01:48 -0700 Subject: [PATCH 1/2] Document installing the JS machinery --- docs/source/development.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/source/development.rst b/docs/source/development.rst index 4a8683c325..a38d666ddf 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -3,6 +3,26 @@ Development =========== +Installing Javascript machinery +------------------------------- + +Running the Notebook from the source code on Github requires some Javascript +tools to build/minify the CSS and Javascript components. We do these steps when +making releases, so there's no need for these tools when installing released +versions of the Notebook. + +First, install `Node.js `_. The installers on the +Node.js website also include Node's package manager, *npm*. Alternatively, +install both of these from your package manager. For example, on Ubuntu or Debian:: + + sudo apt-get install nodejs-legacy npm + +You can then build the Javascript and CSS by running:: + + python setup.py css js + +This will automatically fetch the remaining dependencies (bower, less) and +install them in a subdirectory. CSS live reloading ------------------ From 86ab103195c1ac34dd0e659b0c29e5ff857f29a5 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Fri, 24 Jul 2015 18:02:17 -0700 Subject: [PATCH 2/2] Remove docs on live-rebuilding CSS We moved away from gulp. --- docs/source/development.rst | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/docs/source/development.rst b/docs/source/development.rst index a38d666ddf..cfcac8164b 100644 --- a/docs/source/development.rst +++ b/docs/source/development.rst @@ -23,30 +23,3 @@ You can then build the Javascript and CSS by running:: This will automatically fetch the remaining dependencies (bower, less) and install them in a subdirectory. - -CSS live reloading ------------------- - -If you are working on notebook styling, you can use the live-reloading option -of gulp to watch for changes in the `.less` files and automatically rebuild the -`css` and reload the current page. - -To do so we rely on the livereaload extension of various browser (`for chrome -`_), -and the gulp-livereload extension. - - -To use the livereload extension, in the root of `notebook` project launch:: - - $ gulp watch - - -Any changes to any of the less files under the `notebook/static` -directory will trigger a rebuild of css and ask the reload extension to reload -the current page. - -Do not forget to activate the extension for the current page by clicking on it. -The dot at the center of the extension icon will be come darker when the extension is activated. - - -