mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2024-12-15 04:00:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1062 from minrk/js-dev-doc

Browse Source 
Revisions to js dev doc
This commit is contained in:
Thomas Kluyver 2016-02-08 13:09:50 +00:00
commit 61d2958f02
1 changed files with 18 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/source/development_js.rst
View File

@ -29,22 +29,35 @@ following steps are used when making a Notebook release.
sudo apt-get install nodejs-legacy npm
#. Build the JavaScript and CSS by running:
#. Install the notebook:
In the notebook repo, do a development install:
.. code:: bash
pip install -e .
#. Rebuild JavaScript and CSS
There is a build step for the JavaScript and CSS in the notebook.
You will need to run this command whenever there are changes to JavaScript or LESS sources:
.. code:: bash
python setup.py css js
python setup.py js css
This command will automatically fetch the remaining dependencies (bower,
This command will automatically fetch any missing dependencies (bower,
less) and install them in a subdirectory.
Prototyping tip
---------------
When doing prototyping which needs quick iteration of the Notebook's
JavaScript, the bundled and minified JavaScript may be deactivated. To do
this, start the Notebook with the option
``--NotebookApp.ignore_minified_js=True``. This may highly increase
the number of requests that the browser makes to the server; yet, allows
``--NotebookApp.ignore_minified_js=True``. This increases
the number of requests that the browser makes to the server, but it allows
testing JavaScript file modification without going through the time consuming
compilation step that may take up to 30 seconds.