mirror/notebook
2
0
Fork 0
mirror of https://github.com/jupyter/notebook.git synced 2025-01-18 11:55:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix various comment and spelling

Browse Source
This commit is contained in:
Matthias Bussonnier 2015-12-14 10:44:08 +01:00
parent 11833724ac
commit 254c0a2307
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/source/development_js.rst
View File

@ -3,8 +3,8 @@
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
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.
@ -14,26 +14,26 @@ install both of these from your package manager. For example, on Ubuntu or Debia
sudo apt-get install nodejs-legacy npm
You can then build the Javascript and CSS by running::
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.
For quick iteration on the Notebook's Javascript you can deactivate the use of
the bundled and minified Javacript by using the option
For quick iteration on the Notebook's JavaScript you can deactivate the use of
the bundled and minified JavaScript by using the option
``--NotebookApp.ignore_minified_js=True``. This might though highly increase the
number of requests that the browser make to the server, but can allow to test
Javascript file modification without going through the compilation step that
JavaScript file modification without going through the compilation step that
can take up to 30 sec.
Making a notebook release
-------------------------
Make sure you have followed the step above and have all the tools to genereate
the minified javascript and css files.
Make sure you have followed the step above and have all the tools to generate
the minified JavaScript and CSS files.
Make sure the repository is clean of any file that could be problematic.
You can remove all non-tracked files with:
@ -42,19 +42,19 @@ You can remove all non-tracked files with:
$ git clean -xfdi
This would ask you for confirmation before removing all untracked file. Make
sure the ``dist/`` folder in particular is clean and avoid stale build from
This would ask you for confirmation before removing all untracked files. Make
sure the ``dist/`` folder is clean and avoid stale build from
previous attempts.
Run the following two commands to generate the universal ``wheel`` and the ``sdist``:
1. Run the following commands to generate the universal ``wheel`` and the ``sdist``:
Update version number in ``notebook/_version.py``.
2. Update version number in ``notebook/_version.py``.
Run ``$ python setup.py jsversion``. It will modify (at least)
3. Run ``$ python setup.py jsversion``. It will modify (at least)
``notebook/static/base/js/namespace.js`` to make the notebook version available
from within JavaScript.
Commit and tag the with the current version number:
4 . Commit and tag the release with the current version number:
.. code::
@ -62,7 +62,7 @@ Commit and tag the with the current version number:
git tag $VERSION
You are now ready to build the ``sdist`` and ``wheel``:
5. You are now ready to build the ``sdist`` and ``wheel``:
.. code::
@ -70,8 +70,8 @@ You are now ready to build the ``sdist`` and ``wheel``:
$ python setup.py bdist_wheel
You can now test the ``wheel`` and the ``sdist`` locally before uploading to PyPI.
Make sure to use twine to upload the archives over SSL.
6. You can now test the ``wheel`` and the ``sdist`` locally before uploading to PyPI.
Make sure to use `twine <https://github.com/pypa/twine>`_ to upload the archives over SSL.
.. code::