ipython · fperez · May 24, 2013 · May 15, 2013 · May 15, 2013 · May 15, 2013
diff --git a/IPython/core/tests/test_display.py b/IPython/core/tests/test_display.py
@@ -29,7 +29,7 @@ def test_image_filename_defaults():
                      embed=True)
     nt.assert_raises(ValueError, display.Image)
     nt.assert_raises(ValueError, display.Image, data='this is not an image', format='badformat', embed=True)
-    imgfile = os.path.join(tpath, 'frontend/html/notebook/static/ipynblogo.png')
+    imgfile = os.path.join(tpath, 'frontend/html/notebook/static/base/images/ipynblogo.png')
     img = display.Image(filename=imgfile)
     nt.assert_equal('png', img.format)
     nt.assert_is_not_none(img._repr_png_())

diff --git a/IPython/frontend/html/notebook/README.md b/IPython/frontend/html/notebook/README.md
@@ -1,6 +1,6 @@
 # IPython Notebook development
 
-# Development dependencies
+## Development dependencies
 
 Developers of the IPython Notebook will need to install the following tools:
 
@@ -9,7 +9,7 @@ Developers of the IPython Notebook will need to install the following tools:
 * less (`npm install -g less`)
 * bower (`npm install -g bower`)
 
-# Components
+## Components
 
 We are moving to a model where our JavaScript dependencies are managed using 
 [bower](http://bower.io/). These packages are installed in `static/components`
@@ -22,8 +22,52 @@ we maintain our own fork of CodeMirror that is used with bower. This fork should
 track the upstream CodeMirror exactly; the only difference is that we are adding
 semantic versioned tags to our repo.
 
-# less
+## less
 
 If you edit our `.less` files you will need to run the less compiler to build
 our minified css files.  This can be done by running `fab css` from this directory.
 
+## JavaScript Documentation
+
+
+How to  Build/ view the doc  for JavaScript. JavaScript documentation  should follow a
+style close  to JSDoc  one, so you  should be  able to build  them with  your favorite
+documentation builder. Still  the documentation comment are mainly written  to be read
+with YUI  doc. You can either  build a static version,  or start a YUIdoc  server that
+will live update the doc at every page request.
+
+
+
+To do so, you will need to install YUIdoc.
+
+### Install NodeJS
+
+Node is a browser less javascript interpreter. To install it please refer to
+the documentation for your platform. Install also NPM (node package manager) if
+it does not come bundled with it.  
+
+### Get YUIdoc
+
+npm does by default install package in `./node_modules` instead of doing a
+system wide install. I'll leave you to yuidoc docs if you want to make a system
+wide install.
+
+First, cd into js directory :
+```bash
+cd IPython/frontend/html/notebook/static/js/
+# install yuidoc
+npm install yuidocjs
+```
+
+
+### Run YUIdoc server
+
+From IPython/frontend/html/notebook/static/js/
+```bash
+# run yuidoc for install dir 
+./node_modules/yuidocjs/lib/cli.js --server .
+```
+
+Follow the instruction and the documentation should be available on localhost:3000
+
+Omitting `--server` will build a static version in the `out` folder by default.
diff --git a/IPython/frontend/html/notebook/fabfile.py b/IPython/frontend/html/notebook/fabfile.py
@@ -7,15 +7,24 @@
 static_dir = 'static'
 components_dir = os.path.join(static_dir, 'components')
 
-
-def css(minify=True):
+def css(minify=True, verbose=False):
     """generate the css from less files"""
-    if minify not in ['True', 'False', True, False]:
-        abort('minify must be Boolean')
-    minify = (minify in ['True',True])
+    source = os.path.join('style', 'style.less')
+    target = os.path.join('style', 'style.min.css')
+    _compile_less(source, target, minify, verbose)
+
+def _to_bool(b):
+    if not b in ['True', 'False', True, False]:
+        abort('boolean expected, got: %s' % b)
+    return (b in ['True', True])
 
-    min_flag= '-x' if minify is True else ''
+def _compile_less(source, target, minify=True, verbose=False):
+    """Complie a less file by source and target relative to static_dir"""
+    minify = _to_bool(minify)
+    verbose = _to_bool(verbose)
+    min_flag = '-x' if minify is True else ''
+    ver_flag = '--verbose' if verbose is True else ''
     lessc = os.path.join('components', 'less.js', 'bin', 'lessc')
     with lcd(static_dir):
-        local('{lessc} {min_flag} less/style.less css/style.min.css'.format(**locals()))
+        local('{lessc} {min_flag} {ver_flag} {source} {target}'.format(**locals()))
 
diff --git a/IPython/frontend/html/notebook/notebook/handlers.py b/IPython/frontend/html/notebook/notebook/handlers.py
@@ -43,7 +43,7 @@ def get(self, notebook_id):
         nbm = self.notebook_manager
         if not nbm.notebook_exists(notebook_id):
             raise web.HTTPError(404, u'Notebook does not exist: %s' % notebook_id)       
-        self.write(self.render_template('notebooks.html',
+        self.write(self.render_template('notebook.html',
             project=self.project,
             notebook_id=notebook_id,
             kill_kernel=False,

diff --git a/IPython/frontend/html/notebook/static/auth/css/override.css b/IPython/frontend/html/notebook/static/auth/css/override.css
@@ -0,0 +1,8 @@
+/*This file contains any manual css for this page that needs to override the global styles.
+This is only required when different pages style the same element differently. This is just
+a hack to deal with our current css styles and no new styling should be added in this file.*/
+
+#ipython-main-app {
+    margin: 50px auto;
+    text-align: center;
+}
diff --git a/...tend/html/notebook/static/js/loginmain.js → ...html/notebook/static/auth/js/loginmain.js b/...tend/html/notebook/static/js/loginmain.js → ...html/notebook/static/auth/js/loginmain.js
diff --git a/...nd/html/notebook/static/js/loginwidget.js → ...ml/notebook/static/auth/js/loginwidget.js b/...nd/html/notebook/static/js/loginwidget.js → ...ml/notebook/static/auth/js/loginwidget.js
diff --git a/...end/html/notebook/static/js/logoutmain.js → ...tml/notebook/static/auth/js/logoutmain.js b/...end/html/notebook/static/js/logoutmain.js → ...tml/notebook/static/auth/js/logoutmain.js
diff --git a/IPython/frontend/html/notebook/static/auth/less/login.less b/IPython/frontend/html/notebook/static/auth/less/login.less
@@ -0,0 +1 @@
+// Custom styles for login.html
diff --git a/IPython/frontend/html/notebook/static/auth/less/logout.less b/IPython/frontend/html/notebook/static/auth/less/logout.less
@@ -0,0 +1,2 @@
+// Custom styles for logout.html
+
diff --git a/IPython/frontend/html/notebook/static/auth/less/style.less b/IPython/frontend/html/notebook/static/auth/less/style.less
@@ -0,0 +1,2 @@
+@import "../auth/less/login.less";
+@import "../auth/less/logout.less";
diff --git a/.../html/notebook/static/css/boilerplate.css → .../notebook/static/base/css/boilerplate.css b/.../html/notebook/static/css/boilerplate.css → .../notebook/static/base/css/boilerplate.css
diff --git a/...frontend/html/notebook/static/favicon.ico → ...l/notebook/static/base/images/favicon.ico b/...frontend/html/notebook/static/favicon.ico → ...l/notebook/static/base/images/favicon.ico
diff --git a/...ontend/html/notebook/static/ipynblogo.png → ...notebook/static/base/images/ipynblogo.png b/...ontend/html/notebook/static/ipynblogo.png → ...notebook/static/base/images/ipynblogo.png
diff --git a/...tml/notebook/static/IPy_Notebook_logo.svg → ...notebook/static/base/images/ipynblogo.svg b/...tml/notebook/static/IPy_Notebook_logo.svg → ...notebook/static/base/images/ipynblogo.svg
diff --git a/...rontend/html/notebook/static/js/events.js → ...nd/html/notebook/static/base/js/events.js b/...rontend/html/notebook/static/js/events.js → ...nd/html/notebook/static/base/js/events.js
diff --git a/...tend/html/notebook/static/js/namespace.js → ...html/notebook/static/base/js/namespace.js b/...tend/html/notebook/static/js/namespace.js → ...html/notebook/static/base/js/namespace.js
diff --git a/.../frontend/html/notebook/static/js/page.js → ...tend/html/notebook/static/base/js/page.js b/.../frontend/html/notebook/static/js/page.js → ...tend/html/notebook/static/base/js/page.js
diff --git a/...ntend/html/notebook/static/js/pagemain.js → .../html/notebook/static/base/js/pagemain.js b/...ntend/html/notebook/static/js/pagemain.js → .../html/notebook/static/base/js/pagemain.js
diff --git a/...frontend/html/notebook/static/js/utils.js → ...end/html/notebook/static/base/js/utils.js b/...frontend/html/notebook/static/js/utils.js → ...end/html/notebook/static/base/js/utils.js
diff --git a/...ebook/static/less/flexible-box-model.less → ...ml/notebook/static/base/less/flexbox.less b/...ebook/static/less/flexible-box-model.less → ...ml/notebook/static/base/less/flexbox.less
diff --git a/IPython/frontend/html/notebook/static/base/less/mixins.less b/IPython/frontend/html/notebook/static/base/less/mixins.less
@@ -0,0 +1,11 @@
+// Mixin CSS classes
+
+.border-box-sizing {
+    box-sizing: border-box;
+    -moz-box-sizing: border-box;
+    -webkit-box-sizing: border-box;
+}
+
+.corner-all {
+    border-radius: @corner_radius;
+}
diff --git a/...rontend/html/notebook/static/css/page.css → .../html/notebook/static/base/less/page.less b/...rontend/html/notebook/static/css/page.css → .../html/notebook/static/base/less/page.less
@@ -68,10 +68,3 @@ input.ui-button {
 span#login_widget {
     float: right;
 }
-
-.border-box-sizing {
-    box-sizing: border-box;
-    -moz-box-sizing: border-box;
-    -webkit-box-sizing: border-box;
-}
-
diff --git a/IPython/frontend/html/notebook/static/base/less/style.less b/IPython/frontend/html/notebook/static/base/less/style.less
@@ -0,0 +1,4 @@
+@import "../base/less/variables.less";
+@import "../base/less/mixins.less";
+@import "../base/less/flexbox.less";
+@import "../base/less/page.less";
diff --git a/IPython/frontend/html/notebook/static/base/less/variables.less b/IPython/frontend/html/notebook/static/base/less/variables.less
@@ -0,0 +1,10 @@
+// Our customizations to bootstrap go here.
+
+@textColor:             @black;
+@baseFontSize:          13px;
+@baseLineHeight:        1.231;
+@monoFontFamily:		monospace;  // to allow user to customize their fonts
+
+// Our own global variables for all pages go here
+
+@corner_radius:					4px;
diff --git a/IPython/frontend/html/notebook/static/css/login.css b/IPython/frontend/html/notebook/static/css/login.css
diff --git a/IPython/frontend/html/notebook/static/css/logout.css b/IPython/frontend/html/notebook/static/css/logout.css
diff --git a/...ntend/html/notebook/static/css/custom.css → ...nd/html/notebook/static/custom/custom.css b/...ntend/html/notebook/static/css/custom.css → ...nd/html/notebook/static/custom/custom.css
@@ -1,7 +1,7 @@
 /*
 Placeholder for custom user CSS
 
-mainly to be overridden in profile/static/css/custom.css
+mainly to be overridden in profile/static/custom/custom.css
 
 This will always be an empty file in IPython
 */
diff --git a/...rontend/html/notebook/static/js/custom.js → ...end/html/notebook/static/custom/custom.js b/...rontend/html/notebook/static/js/custom.js → ...end/html/notebook/static/custom/custom.js
@@ -3,14 +3,14 @@
  *
  *
  * Placeholder for custom user javascript
- * mainly to be overridden in profile/static/js/custom.js
+ * mainly to be overridden in profile/static/custom/custom.js
  * This will always be an empty file in IPython
  *
- * User could add any javascript in the `profile/static/js/custom.js` file
+ * User could add any javascript in the `profile/static/custom/custom.js` file
  * (and should create it if it does not exist).
  * It will be executed by the ipython notebook at load time.
  *
- * Same thing with `profile/static/css/custom.css` to inject custom css into the notebook.
+ * Same thing with `profile/static/custom/custom.css` to inject custom css into the notebook.
  *
  * Example :
  *
@@ -34,10 +34,10 @@
  *  to load custom script into the notebook.
  *
  *    // to load the metadata ui extension example.
- *    $.getScript('/static/js/celltoolbarpresets/example.js');
+ *    $.getScript('/static/notebook/js/celltoolbarpresets/example.js');
  *    // or
  *    // to load the metadata ui extension to control slideshow mode / reveal js for nbconvert
- *    $.getScript('/static/js/celltoolbarpresets/slideshow.js');
+ *    $.getScript('/static/notebook/js/celltoolbarpresets/slideshow.js');
  *
  *
  * @module IPython

diff --git a/IPython/frontend/html/notebook/static/js/README.md b/IPython/frontend/html/notebook/static/js/README.md
diff --git a/IPython/frontend/html/notebook/static/less/bootstrap-custom.less b/IPython/frontend/html/notebook/static/less/bootstrap-custom.less
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		@import "../auth/less/login.less";
		@import "../auth/less/logout.less";