additional_resources_menu

A JupyterLab extension.

This extension adds an Additional Resources submenu to the Help Menu in JupyterLab. This submenu provides links to outside documentation as set in the overrides.json file (see Configuration).

Requirements

• JupyterLab >= 3.0

Install

To install the extension, enter the root repository folder and execute:

pip install .

Uninstall

To remove the extension, execute:

pip uninstall additional_resources_menu

If that does not work, you can directly delete the extension folder from Jupyter. See this link to find where extensions are installed.

Configuration

The additional resources menu is populated with links that are specified in the overrides.json file. Click this link to see where your overrides.json file is installed. This will set the additional resources for all users who access Jupyter through the shared install (so this file must be set for all virtual environments or installs).

View the example_overrides.json file above to see how to format this file

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the additional_resources_menu directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm run build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall additional_resources_menu

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named additional-resources-menu within that folder.