From 96032f7ec1a65826f011baaae57e589ddbd00381 Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Fri, 24 Jul 2015 18:01:48 -0700 Subject: [PATCH] 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 4a8683c32..a38d666dd 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 ------------------