Package: jupyterlab-jupyterbook-navigation
jupyterlab_jupyterbook_navigationA JupyterLab server extension that provides Jupyter-Book navigation via a sidepanel widget holding a Jupyter-Book table of contents.[!WARNING]
This package is currently in a pre-alpha stage:Expect Significant Changes:Features, functionality, and the overall design may change significantly in future updates.Limited Functionality and Correctness:There are no guarantees of full functionality or correctness.Use at Your Own Risk:Given its early stage of development, users should exercise caution when integrating this package into critical systems.https://github.com/ASFOpenSARlab/jupyterlab-jupyterbook-navigation/assets/37909088/3aa48f43-dfeb-466d-8f33-afc10f333f50This extension is composed of a Python package namedjupyterlab_jupyterbook_navigationfor the server extension and a NPM package namedjupyterlab-jupyterbook-navigationfor the frontend extension.RequirementsJupyterLab >= 4.0.0InstallTo install the extension, execute:pipinstalljupyterlab_jupyterbook_navigationUninstallTo remove the extension, execute:pipuninstalljupyterlab_jupyterbook_navigationContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab_jupyterbook_navigation directory# Install package in development modepipinstall-e"."# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Rebuild extension Typescript source after making changesjlpmbuildYou 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 neededjlpmwatch# Run JupyterLab in another terminaljupyterlabWith 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, thejlpm buildcommand 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:jupyterlabbuild--minimize=FalseDevelopment uninstallpipuninstalljupyterlab_jupyterbook_navigationIn development mode, you will also need to remove the symlink created byjupyter labextension developcommand. To find its location, you can runjupyter labextension listto figure out where thelabextensionsfolder is located. Then you can remove the symlink namedjupyterlab-jupyterbook-navigationwithin that folder.Testing the extensionFrontend testsThis extension is usingJestfor JavaScript code testing.To execute them, execute:jlpm
jlpmtestIntegration testsThis extension usesPlaywrightfor the integration tests (aka user level tests).
More precisely, the JupyterLab helperGalatais used to handle testing the extension in JupyterLab.More information are provided within theui-testsREADME.Packaging the extensionSeeRELEASE