Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Where is a docs for Jupyter front-end extensions JavaScript API?

I've read the docs about writing the Jupyter front-end extensions, and learn the examples, and now can build the simple extension by myself.

But - where is a complete docs for Jupyter extensions JavaScript API? How to find the JavaScript API for notebook properties and methods?

like image 833
Y.N Avatar asked Jul 18 '18 22:07

Y.N


People also ask

How do I check my Jupyter Notebook extensions?

Now open Jupyter Notebooks. There should be a new tab called “Nbextensions.” Click on it and you'll see a bunch of extensions you can use to increase your productivity on Jupyter Notebooks.

How do you put extensions in a Jupyter Notebook?

After installing, open Jupyter Notebook. You will see a new tab, “Nbextensions” will appear in the menu (as shown in the image). When you click it, you will see a list of available extensions that you can use to increase your productivity of Jupyter Notebook.

What is the extension for Jupyter Notebook files?

ipynb file extension is used for computational notebooks that can be open with Jupyter Notebook. The Jupyter Notebook was formerly named IPython Notebook. The extension *. ipynb is from letters IPython Notebook.

Is there a Jupyter Notebook for Javascript?

IJavascript is a Javascript kernel for the Jupyter notebook. The Jupyter notebook combines the creation of rich-text documents (including equations, graphs and videos) with the execution of code in a number of programming languages.


2 Answers

For newcomers it might be confusing that there are several projects with similar names for historical reasons:

a) Jupyter
https://github.com/jupyter

b) JupyterLab
https://github.com/jupyterlab/

The webpage https://jupyter.org/ references the newer b). However, the sub projects of a) do not include deprecation warnings.

=> If you find some documentation via search engine, you have to be careful if its related to a) or b).

Current documentation for JupyterLab extensions can be found here:

  • General info: https://jupyterlab.readthedocs.io/en/3.2.x/user/extensions.html

  • Javascript API doc: https://jupyterlab.readthedocs.io/en/stable/api/modules.html

  • Examples: https://github.com/jupyterlab/extension-examples

  • Discussion forum: https://discourse.jupyter.org/c/jupyterlab/extensions/

Related:

https://www.quora.com/What-is-the-difference-between-JupyterLab-and-Jupyter-Notebook-Is-there-a-use-case-for-one-over-the-other?share=1

https://github.com/jupyterlab/jupyterlab-plugin-playground

like image 193
Stefan Avatar answered Oct 09 '22 02:10

Stefan


Apparently, there are is no front-end API documentation, as there is an open GitHub issue that even references your SO question. Maybe a few +1s on the issue might change this, although I suspect that the answer (if any) will point to JupyterLab, which has a defined front-end API but has no common technical base with Jupyter Notebook front-end extensions.

like image 1
Bernhard Stadler Avatar answered Oct 09 '22 01:10

Bernhard Stadler