additional_resources_menu

一个JupyterLab扩展。

此扩展向JupyterLab的帮助菜单中添加了一个“额外资源”子菜单。此子菜单提供指向在overrides.json文件中设置的文档的链接（见配置）。

要求

• JupyterLab >= 3.0

安装

要安装扩展，请进入根存储库文件夹并执行

pip install additional-resources-menu

卸载

要删除扩展，请执行

pip uninstall additional-resources-menu

如果不起作用，您可以直接从Jupyter中删除扩展文件夹。请参阅此链接以查找扩展的安装位置。

配置

额外资源菜单包含在overrides.json文件中指定的链接。点击此链接查看您的overrides.json文件安装的位置。这将设置所有通过共享安装访问Jupyter的用户（因此此文件必须为所有虚拟环境或安装设置）的额外资源。

查看上面的example_overrides.json文件以了解如何格式化此文件

贡献

开发安装

注意：您需要NodeJS来构建扩展包。

jlpm命令是JupyterLab安装的yarn的固定版本，可以通过JupyterLab安装。您可以使用yarn或npm替代下面的jlpm。

# 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

您可以在不同的终端中同时监视源目录并运行JupyterLab，以监视扩展源代码的变化并自动重新构建扩展。

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

当监视命令运行时，每次保存的更改都会立即在本地上构建并可在您运行的JupyterLab中使用。刷新JupyterLab以在浏览器中加载更改（您可能需要等待几秒钟以重建扩展）。

默认情况下，jlpm run build命令为该扩展生成源映射，以便使用浏览器开发者工具进行调试。要同时为JupyterLab核心扩展生成源映射，您可以运行以下命令

jupyter lab build --minimize=False

开发卸载

pip uninstall additional_resources_menu

在开发模式下，您还需要删除由jupyter labextension develop命令创建的符号链接。要找到其位置，您可以运行jupyter labextension list以确定labextensions文件夹的位置。然后您可以在该文件夹中删除名为additional-resources-menu的符号链接。