Show More
@@ -1,73 +1,73 b'' | |||||
1 | # IPython Notebook development |
|
1 | # IPython Notebook development | |
2 |
|
2 | |||
3 | ## Development dependencies |
|
3 | ## Development dependencies | |
4 |
|
4 | |||
5 | Developers of the IPython Notebook will need to install the following tools: |
|
5 | Developers of the IPython Notebook will need to install the following tools: | |
6 |
|
6 | |||
7 | * fabric |
|
7 | * fabric | |
8 | * node.js |
|
8 | * node.js | |
9 | * less (`npm install -g less`) |
|
9 | * less (`npm install -g less`) | |
10 | * bower (`npm install -g bower`) |
|
10 | * bower (`npm install -g bower`) | |
11 |
|
11 | |||
12 | ## Components |
|
12 | ## Components | |
13 |
|
13 | |||
14 | We are moving to a model where our JavaScript dependencies are managed using |
|
14 | We are moving to a model where our JavaScript dependencies are managed using | |
15 | [bower](http://bower.io/). These packages are installed in `static/components` |
|
15 | [bower](http://bower.io/). These packages are installed in `static/components` | |
16 | and commited into our git repo. Our dependencies are described in the file |
|
16 | and committed into our git repo. Our dependencies are described in the file | |
17 |
`static/bower.json`. To update our bower packages, run `fab |
|
17 | `static/components/bower.json`. To update our bower packages, run `fab | |
18 | directory. |
|
18 | components` in this directory. | |
19 |
|
19 | |||
20 | Because CodeMirror does not use proper semantic versioning for its GitHub tags, |
|
20 | Because CodeMirror does not use proper semantic versioning for its GitHub tags, | |
21 | we maintain our own fork of CodeMirror that is used with bower. This fork should |
|
21 | we maintain our own fork of CodeMirror that is used with bower. This fork should | |
22 | track the upstream CodeMirror exactly; the only difference is that we are adding |
|
22 | track the upstream CodeMirror exactly; the only difference is that we are adding | |
23 | semantic versioned tags to our repo. |
|
23 | semantic versioned tags to our repo. | |
24 |
|
24 | |||
25 | ## less |
|
25 | ## less | |
26 |
|
26 | |||
27 | If you edit our `.less` files you will need to run the less compiler to build |
|
27 | If you edit our `.less` files you will need to run the less compiler to build | |
28 | our minified css files. This can be done by running `fab css` from this directory. |
|
28 | our minified css files. This can be done by running `fab css` from this directory. | |
29 |
|
29 | |||
30 | ## JavaScript Documentation |
|
30 | ## JavaScript Documentation | |
31 |
|
31 | |||
32 |
|
32 | |||
33 | How to Build/ view the doc for JavaScript. JavaScript documentation should follow a |
|
33 | How to Build/ view the doc for JavaScript. JavaScript documentation should follow a | |
34 | style close to JSDoc one, so you should be able to build them with your favorite |
|
34 | style close to JSDoc one, so you should be able to build them with your favorite | |
35 | documentation builder. Still the documentation comment are mainly written to be read |
|
35 | documentation builder. Still the documentation comment are mainly written to be read | |
36 | with YUI doc. You can either build a static version, or start a YUIdoc server that |
|
36 | with YUI doc. You can either build a static version, or start a YUIdoc server that | |
37 | will live update the doc at every page request. |
|
37 | will live update the doc at every page request. | |
38 |
|
38 | |||
39 |
|
39 | |||
40 |
|
40 | |||
41 | To do so, you will need to install YUIdoc. |
|
41 | To do so, you will need to install YUIdoc. | |
42 |
|
42 | |||
43 | ### Install NodeJS |
|
43 | ### Install NodeJS | |
44 |
|
44 | |||
45 | Node is a browser less javascript interpreter. To install it please refer to |
|
45 | Node is a browser less javascript interpreter. To install it please refer to | |
46 | the documentation for your platform. Install also NPM (node package manager) if |
|
46 | the documentation for your platform. Install also NPM (node package manager) if | |
47 | it does not come bundled with it. |
|
47 | it does not come bundled with it. | |
48 |
|
48 | |||
49 | ### Get YUIdoc |
|
49 | ### Get YUIdoc | |
50 |
|
50 | |||
51 | npm does by default install package in `./node_modules` instead of doing a |
|
51 | npm does by default install package in `./node_modules` instead of doing a | |
52 | system wide install. I'll leave you to yuidoc docs if you want to make a system |
|
52 | system wide install. I'll leave you to yuidoc docs if you want to make a system | |
53 | wide install. |
|
53 | wide install. | |
54 |
|
54 | |||
55 | First, cd into js directory : |
|
55 | First, cd into js directory : | |
56 | ```bash |
|
56 | ```bash | |
57 | cd IPython/html/static/js/ |
|
57 | cd IPython/html/static/js/ | |
58 | # install yuidoc |
|
58 | # install yuidoc | |
59 | npm install yuidocjs |
|
59 | npm install yuidocjs | |
60 | ``` |
|
60 | ``` | |
61 |
|
61 | |||
62 |
|
62 | |||
63 | ### Run YUIdoc server |
|
63 | ### Run YUIdoc server | |
64 |
|
64 | |||
65 | From IPython/html/static/js/ |
|
65 | From IPython/html/static/js/ | |
66 | ```bash |
|
66 | ```bash | |
67 | # run yuidoc for install dir |
|
67 | # run yuidoc for install dir | |
68 | ./node_modules/yuidocjs/lib/cli.js --server . |
|
68 | ./node_modules/yuidocjs/lib/cli.js --server . | |
69 | ``` |
|
69 | ``` | |
70 |
|
70 | |||
71 | Follow the instruction and the documentation should be available on localhost:3000 |
|
71 | Follow the instruction and the documentation should be available on localhost:3000 | |
72 |
|
72 | |||
73 | Omitting `--server` will build a static version in the `out` folder by default. |
|
73 | Omitting `--server` will build a static version in the `out` folder by default. |
General Comments 0
You need to be logged in to leave comments.
Login now