Documentation #14788

startakovsky · 2023-07-03T12:44:51Z

Description

I would like to turn this PR into a tar ball and I have gone through the installation of the "jlpm" tool though the tarball it generates appears to just be the 4.0.2 release even though I have checked out the PR. Please advise on what I should do to produce the tarball, or documentation I can read.

Reproduce

Go to '...'
Click on '...'
Scroll down to '...'
See error '...'

Expected behavior

Context

Operating System and version:
Browser and version:
JupyterLab version:

Troubleshoot Output

Paste the output from running `jupyter troubleshoot` from the command line here.
You may want to sanitize the paths in the output.

Command Line Output

Paste the output from your command line running `jupyter lab` here, use `--debug` if possible.

Browser Output

Paste the output from your browser Javascript console here, if applicable.

JasonWeill · 2023-07-03T16:45:35Z

What are you trying to do? If you've checked out the bollwyvl:add-mermaid-to-marked branch mentioned in the PR, you should be able to build a local version of JupyterLab, numbered as 4.0.2 (since that's the most recent JupyterLab release). Do you see any errors when you do this?

startakovsky · 2023-07-03T17:38:12Z

Thanks @JasonWeill, here's what I did: jlpm run build | pbcopy and I will paste the output below. Where is the tar file? I remember seeing one before. I would like to install it on a fresh virtual environment to test out this mermaid rendering feature, and use it on an existing project (where I will swap it out for the released jupyterlab when 4.1 is released).

> @jupyterlab/repo-top@0.0.1 build:dev
> npm run integrity && npm run build:all && cd dev_mode && npm run build


> @jupyterlab/repo-top@0.0.1 integrity
> node scripts/ensure-buildutils.js && node buildutils/lib/ensure-repo.js

Repo integrity verified!

> @jupyterlab/repo-top@0.0.1 prebuild:all
> npm run build:utils && npm run build:builder


> @jupyterlab/repo-top@0.0.1 build:utils
> cd buildutils && npm run build


> @jupyterlab/buildutils@4.0.2 build
> tsc && cd template && npm run build


> @jupyterlab/template@4.0.2 build
> tsc -b


> @jupyterlab/repo-top@0.0.1 build:builder
> cd builder && npm run build


> @jupyterlab/builder@4.0.2 build
> tsc


> @jupyterlab/repo-top@0.0.1 build:all
> lerna run build:all


 >  Lerna (powered by Nx)   Running target build:all for 5 projects:

    - @jupyterlab/lsp-extension
    - @jupyterlab/metapackage
    - @jupyterlab/nbconvert-css
    - @jupyterlab/services
    - @jupyterlab/testing

 

> @jupyterlab/testing:"build:all"


> @jupyterlab/testing@4.0.2 build
> tsc -b


> @jupyterlab/services:"build:all"


> @jupyterlab/services@7.0.2 build
> tsc -b

asset �[1m�[32m./dist/index.js�[39m�[22m 139 KiB �[1m�[33m[compared for emit]�[39m�[22m �[1m�[32m[minimized]�[39m�[22m (name: main) 1 related asset
runtime modules 1.13 KiB 5 modules
orphan modules 75.9 KiB �[1m�[33m[orphan]�[39m�[22m 1 module
modules by path �[1m./lib/�[39m�[22m 261 KiB 41 modules
modules by path �[1m../�[39m�[22m 239 KiB
  modules by path �[1m../coreutils/lib/*.js�[39m�[22m 35.4 KiB 11 modules
  modules by path �[1m../../node_modules/�[39m�[22m 182 KiB
    modules by path �[1m../../node_modules/@lumino/�[39m�[22m 140 KiB 5 modules
    + 5 modules
  modules by path �[1m../statedb/lib/*.js�[39m�[22m 21.8 KiB
    �[1m../statedb/lib/index.js�[39m�[22m 1.31 KiB �[1m�[33m[built]�[39m�[22m �[1m�[33m[code generated]�[39m�[22m
    + 5 modules
webpack 5.76.1 compiled �[1m�[32msuccessfully�[39m�[22m in 948 ms

> @jupyterlab/lsp-extension:"build:all"


> @jupyterlab/lsp-extension@4.0.2 build
> tsc -b


> @jupyterlab/nbconvert-css:"build:all"


> @jupyterlab/nbconvert-css@4.0.2 build
> webpack --mode=production

asset �[1m�[32mindex.css�[39m�[22m 237 KiB �[1m�[33m[compared for emit]�[39m�[22m (name: main)
asset �[1m�[32mindex.js�[39m�[22m 0 bytes �[1m�[33m[compared for emit]�[39m�[22m �[1m�[32m[minimized]�[39m�[22m (name: main)
Entrypoint �[1mmain�[39m�[22m 237 KiB = �[1m�[32mindex.css�[39m�[22m 237 KiB �[1m�[32mindex.js�[39m�[22m 0 bytes
orphan modules 314 KiB (javascript) 14.7 KiB (runtime) �[1m�[33m[orphan]�[39m�[22m 263 modules
cacheable modules 237 KiB (css/mini-extract) 9.92 KiB (javascript)
  modules by path �[1m../ui-components/style/�[39m�[22m 129 KiB 17 modules
  modules by path �[1m../../node_modules/@lumino/�[39m�[22m 12.2 KiB 12 modules
  modules by path �[1m../apputils/style/�[39m�[22m 17.7 KiB 6 modules
  modules by path �[1m../cells/style/�[39m�[22m 12.2 KiB
    css ../../node_modules/css-loader/dist/cjs.js!�[1m../cells/style/collapser.css�[39m�[22m 1.01 KiB �[1m�[33m[built]�[39m�[22m �[1m�[33m[code generated]�[39m�[22m
    + 5 modules
  modules by path �[1m../notebook/style/�[39m�[22m 16.4 KiB
    css ../../node_modules/css-loader/dist/cjs.js!�[1m../notebook/style/toolbar.css�[39m�[22m 1.78 KiB �[1m�[33m[built]�[39m�[22m �[1m�[33m[code generated]�[39m�[22m
    + 4 modules
  modules by path �[1m../codeeditor/style/�[39m�[22m 2.77 KiB
    css ../../node_modules/css-loader/dist/cjs.js!�[1m../codeeditor/style/linecol.css�[39m�[22m 1.51 KiB �[1m�[33m[built]�[39m�[22m �[1m�[33m[code generated]�[39m�[22m
    css ../../node_modules/css-loader/dist/cjs.js!�[1m../codeeditor/style/base.css�[39m�[22m 1.26 KiB �[1m�[33m[built]�[39m�[22m �[1m�[33m[code generated]�[39m�[22m
  + 10 modules
webpack 5.76.1 compiled �[1m�[32msuccessfully�[39m�[22m in 326 ms

> @jupyterlab/metapackage:"build:all"


> @jupyterlab/metapackage@4.0.2 build
> tsc -b


 

 >  Lerna (powered by Nx)   Successfully ran target build:all for 5 projects



> @jupyterlab/repo-top@0.0.1 postbuild:all
> npm run build:testutils && npm run build:galata


> @jupyterlab/repo-top@0.0.1 build:testutils
> cd testutils && npm run build


> @jupyterlab/testutils@4.0.2 build
> tsc -b


> @jupyterlab/repo-top@0.0.1 build:galata
> cd galata && npm run build


> @jupyterlab/galata@5.0.2 build
> npm run build:extension && npm run build:galata


> @jupyterlab/galata@5.0.2 build:extension
> cd extension && npm run build && cd ..


> @jupyterlab/galata-extension@5.0.2 build
> npm run build:lib && npm run build:labextension


> @jupyterlab/galata-extension@5.0.2 build:lib
> tsc


> @jupyterlab/galata-extension@5.0.2 build:labextension
> node ../../node_modules/@jupyterlab/builder/lib/build-labextension.js --core-path ../../dev_mode --development .

asset remoteEntry.7474c5708cc3fa5789e6.js 27.1 KiB [emitted] [immutable] (name: @jupyterlab/galata-extension) 1 related asset
asset lib_extension_index_js.6258249575a3de76958a.js 24.1 KiB [emitted] [immutable] 1 related asset
runtime modules 18.3 KiB 12 modules
built modules 20.6 KiB (javascript) 168 bytes (consume-shared) 42 bytes (share-init) [built]
  javascript modules 20.6 KiB
    container entry 42 bytes [built] [code generated]
    ../lib/extension/index.js 720 bytes [built] [code generated]
    ../lib/extension/global.js 19.4 KiB [built] [code generated]
    ../lib/extension/tokens.js 461 bytes [built] [code generated]
  consume-shared-module modules 168 bytes
    consume shared module (default) @jupyterlab/apputils@^4.1.2 (singleton) 42 bytes [built] [code generated]
    consume shared module (default) @lumino/algorithm@^2.0.0 (singleton) 42 bytes [built] [code generated]
    consume shared module (default) @lumino/signaling@^2.0.0 (singleton) 42 bytes [built] [code generated]
    consume shared module (default) @lumino/coreutils@^2.0.0 (singleton) 42 bytes [built] [code generated]
  provide shared module (default) @jupyterlab/galata-extension@5.0.2 = ../lib/extension/index.js 42 bytes [built] [code generated]
webpack 5.76.1 compiled successfully in 166 ms

> @jupyterlab/galata@5.0.2 build:galata
> tsc -b


> @jupyterlab/application-top@4.0.2 build
> npm run clean && webpack


> @jupyterlab/application-top@4.0.2 clean
> rimraf build

assets by path *.js 65.7 MiB
  assets by chunk 44.3 MiB (id hint: vendors)
    asset vendors-node_modules_lodash-es_isPlainObject_js-node_modules_mermaid_dist_flowchart-elk-defin-463a4d.4cc6332468b6cbad27c9.js 4.05 MiB [emitted] [immutable] (id hint: vendors)
    asset vendors-node_modules_mermaid_dist_mindmap-definition-89ece3a3_js.70551b48aa8afe51c277.js 3.02 MiB [emitted] [immutable] (id hint: vendors)
    asset vendors-node_modules_react-dom_index_js.cd2819702d9dfe4c990e.js 2.55 MiB [emitted] [immutable] (id hint: vendors)
    + 115 assets
  + 203 assets
assets by chunk 3.11 MiB (auxiliary id hint: vendors)
  assets by path *.woff 524 KiB 25 assets
  assets by path *.svg 1.73 MiB 3 assets
  assets by path *.eot 363 KiB 3 assets
  assets by path *.ttf 362 KiB 3 assets
  assets by path *.woff2 164 KiB 3 assets
asset index.html 1.96 KiB [emitted]
Entrypoint main 798 KiB = vendors-node_modules_whatwg-fetch_fetch_js.ca4e2e1e816b94c47010.js 44 KiB main.1f94655a33df561268f0.js 754 KiB
orphan modules 597 KiB [orphan] 543 modules
runtime modules 301 KiB 17 modules
javascript modules 21.3 MiB
  modules by path ../node_modules/ 16.8 MiB 2348 modules
  modules by path ../packages/ 4.44 MiB 737 modules
  modules by path ./ 24.7 KiB 5 modules
  + 5 modules
asset modules 156 KiB (javascript) 3.11 MiB (asset) 254 modules
provide-module modules 5.25 KiB 128 modules
consume-shared-module modules 5.25 KiB 128 modules
json modules 77.3 KiB
  modules by path ../node_modules/htmlparser2/ 30 KiB 4 modules
  modules by path ../node_modules/domutils/ 30 KiB 4 modules
  modules by path ../node_modules/ajv/dist/ 3.07 KiB 2 modules
  + 3 modules

WARNING in color-name
  Multiple versions of color-name found:
    1.1.3 /Users/steven/code/jupyterlab/~/color-convert/~/color-name from /Users/steven/code/jupyterlab/~/color-convert/conversions.js
    1.1.4 /Users/steven/code/jupyterlab/~/color-name from /Users/steven/code/jupyterlab/~/color-string/index.js

Check how you can resolve duplicate packages: 
https://github.com/darrenscerri/duplicate-package-checker-webpack-plugin#resolving-duplicate-packages-in-your-bundle

webpack 5.76.1 compiled with 1 warning in 6203 ms

asset index.css 17.3 KiB [compared for emit] (name: index)
asset index.js 0 bytes [compared for emit] [minimized] (name: index)
Entrypoint index 17.3 KiB = index.css 17.3 KiB index.js 0 bytes
orphan modules 21.1 KiB (javascript) 937 bytes (runtime) [orphan] 8 modules
cacheable modules 50 bytes (javascript) 17.3 KiB (css/mini-extract)
  ../packages/theme-dark-extension/style/theme.css 50 bytes [built] [code generated]
  css ../node_modules/css-loader/dist/cjs.js!../packages/theme-dark-extension/style/variables.css 16.7 KiB [built] [code generated]
  css ../node_modules/css-loader/dist/cjs.js!../packages/theme-dark-extension/style/theme.css 656 bytes [built] [code generated]
webpack 5.76.1 compiled successfully in 342 ms

asset index.css 16.1 KiB [compared for emit] (name: index)
asset index.js 0 bytes [compared for emit] [minimized] (name: index)
Entrypoint index 16.1 KiB = index.css 16.1 KiB index.js 0 bytes
orphan modules 19.9 KiB (javascript) 937 bytes (runtime) [orphan] 8 modules
cacheable modules 50 bytes (javascript) 16.1 KiB (css/mini-extract)
  ../packages/theme-light-extension/style/theme.css 50 bytes [built] [code generated]
  css ../node_modules/css-loader/dist/cjs.js!../packages/theme-light-extension/style/variables.css 15.6 KiB [built] [code generated]
  css ../node_modules/css-loader/dist/cjs.js!../packages/theme-light-extension/style/theme.css 472 bytes [built] [code generated]
webpack 5.76.1 compiled successfully in 400 ms

JasonWeill · 2023-07-03T17:51:32Z

You can find our documentation about building locally here: https://jupyterlab.readthedocs.io/en/latest/developer/contributing.html#installing-jupyterlab

I don't have experience with running jlpm build or jlpm run build to generate a tarball for use on another system. The build:packages step builds NPM packages. If you want to build code from source, I would recommend using the docs linked above to check out @bollwyvl 's branch on the system where you want to build and run it, then build and run it locally.

startakovsky · 2023-07-03T18:22:36Z

Thanks @JasonWeill, yes, I did follow those docs before creating this Documentation issue in order to get to the point where I ran thejlpm run build command. I am just trying to generate the package to pip install. It doesn't have to be a tarball.

If it is any help, from what I can tell jupyter lab doesn't seem to incorporate the checked out PR even when running jlpm run build:dev:prod from the documentation you sent my way. jupyter lab --dev-mode does seem to render correctly (see images below).

Either way, I am not seeing something that I can end up pip-installing elsewhere. Thank you again.

When I run jupyter lab I get this:

When I run jupyter lab --dev-mode I get this:

JasonWeill · 2023-07-11T16:22:24Z

Building locally and running --dev-mode are normal processes for building and running extensions locally, while you're developing. To make an extension available for other developers, our extension development documentation recommends publishing it somewhere, or making the source code available so that other users can download and install the code locally (the latter is used for much earlier-stage extensions under active development).

startakovsky added the bug label Jul 3, 2023

jupyterlab-probot bot added the status:Needs Triage Applied to new issues that need triage label Jul 3, 2023

JasonWeill added the status:Needs Info label Jul 3, 2023

JasonWeill mentioned this issue Jul 11, 2023

Weekly Triage meetings: Jul–Dec 2023 jupyterlab/frontends-team-compass#203

Closed

JasonWeill closed this as completed Jul 18, 2023

startakovsky mentioned this issue Sep 20, 2023

Mermaid Usage Instructions Missing #15139

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Documentation #14788

Documentation #14788

startakovsky commented Jul 3, 2023

JasonWeill commented Jul 3, 2023

startakovsky commented Jul 3, 2023

JasonWeill commented Jul 3, 2023

startakovsky commented Jul 3, 2023

JasonWeill commented Jul 11, 2023

Documentation #14788

Documentation #14788

Comments

startakovsky commented Jul 3, 2023

Description

Reproduce

Expected behavior

Context

JasonWeill commented Jul 3, 2023

startakovsky commented Jul 3, 2023

JasonWeill commented Jul 3, 2023

startakovsky commented Jul 3, 2023

JasonWeill commented Jul 11, 2023