|
@@ -122,24 +122,7 @@ The JupyterLab application is made up of two major parts:
|
|
|
Each part is named `jupyterlab`. The [developer tutorial documentation](http://jupyterlab-tutorial.readthedocs.io/en/latest/index.html)
|
|
|
provides additional architecture information.
|
|
|
|
|
|
-
|
|
|
-When you make a change to JupyterLab npm package source files, run:
|
|
|
-
|
|
|
-```bash
|
|
|
-npm run build:serverextension
|
|
|
-```
|
|
|
-
|
|
|
-to build the changes and refresh your browser to see the changes.
|
|
|
-
|
|
|
-To have the system build after each change to the source files, run:
|
|
|
-
|
|
|
-```bash
|
|
|
-npm run watch:serverextension
|
|
|
-```
|
|
|
-
|
|
|
-and refresh the browser after each successful update.
|
|
|
-
|
|
|
-## NPM Package
|
|
|
+## The NPM Package
|
|
|
|
|
|
The npm package source files are in the `src/` subdirectory.
|
|
|
|
|
@@ -151,7 +134,7 @@ The npm package source files are in the `src/` subdirectory.
|
|
|
npm install --save jupyterlab
|
|
|
```
|
|
|
|
|
|
-### NPM Source Build
|
|
|
+### Build the NPM Package from Source
|
|
|
|
|
|
```bash
|
|
|
git clone https://github.com/jupyter/jupyterlab.git
|
|
@@ -167,32 +150,38 @@ npm run clean
|
|
|
npm run build:all
|
|
|
```
|
|
|
|
|
|
+## The Jupyter Server Extension
|
|
|
|
|
|
-### Install the Jupyter Server Extension
|
|
|
-
|
|
|
-The Jupyter server extension source files are in the `jupyterlab/` subdirectory. To use this extension, you need the Jupyter notebook server version 4.2 or later.
|
|
|
+The Jupyter server extension source files are in the `jupyterlab/` subdirectory.
|
|
|
+To use this extension, you need the Jupyter notebook server version 4.2 or later.
|
|
|
|
|
|
### Build JupyterLab server extension
|
|
|
|
|
|
+When you make a change to JupyterLab npm package source files, run:
|
|
|
+
|
|
|
```bash
|
|
|
npm run build:serverextension
|
|
|
```
|
|
|
|
|
|
-----
|
|
|
+to build the changes and refresh your browser to see the changes.
|
|
|
|
|
|
-----
|
|
|
+To have the system build after each change to the source files, run:
|
|
|
+
|
|
|
+```bash
|
|
|
+npm run watch:serverextension
|
|
|
+```
|
|
|
|
|
|
-## Publishing packages for a JupyterLab release
|
|
|
+and refresh the browser after each successful update.
|
|
|
|
|
|
-We publish an npm package, a pypi source package, and a pypi universal binary wheel.
|
|
|
+## Bundle for the Browser
|
|
|
|
|
|
-```bash
|
|
|
-npm version patch
|
|
|
-git push origin master --tags
|
|
|
-npm publish
|
|
|
-python setup.py sdist upload
|
|
|
-python setup.py bdist_wheel --universal upload
|
|
|
-```
|
|
|
+Follow the package install instructions first.
|
|
|
+
|
|
|
+Any bundler that understands how to `require()` files with `.js` and `.css`
|
|
|
+extensions can be used with this package.
|
|
|
+
|
|
|
+**Note:** This npm module is fully compatible with Node/Babel/ES6/ES5. Simply
|
|
|
+omit the type declarations when using a language other than TypeScript.
|
|
|
|
|
|
## Supported Runtimes
|
|
|
|
|
@@ -206,12 +195,14 @@ Earlier versions may also work, but come with no guarantees.
|
|
|
Note: "requirejs" must be included in a global context (usually as a
|
|
|
`<script>` tag) for Comm targets.
|
|
|
|
|
|
-## Bundle for the Browser
|
|
|
-
|
|
|
-Follow the package install instructions first.
|
|
|
+## Publishing packages for a JupyterLab release
|
|
|
|
|
|
-Any bundler that understands how to `require()` files with `.js` and `.css`
|
|
|
-extensions can be used with this package.
|
|
|
+We publish an npm package, a pypi source package, and a pypi universal binary wheel.
|
|
|
|
|
|
-**Note:** This npm module is fully compatible with Node/Babel/ES6/ES5. Simply
|
|
|
-omit the type declarations when using a language other than TypeScript.
|
|
|
+```bash
|
|
|
+npm version patch
|
|
|
+git push origin master --tags
|
|
|
+npm publish
|
|
|
+python setup.py sdist upload
|
|
|
+python setup.py bdist_wheel --universal upload
|
|
|
+```
|