Skip to main content

JupyterLab Table of Contents extension that includes code cells and markdown content other than headings.

Project description

Table of Contents Extension with Code & Markdown

PyPI version Github Actions Status Binder

JupyterLab Table of Contents extension that includes code cells and markdown content other than headings.

Demonstration

The code cell display can be toggled on/off, and so is the markdown cell content. Table of contents entries can also be filtered by cell metadata tags with the toolbar button on the right.

demo_gif

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install jupyterlabcodetoc

Uninstall

To remove the extension, execute:

pip uninstall jupyterlabcodetoc

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 jupyterlabcodetoc 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 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 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 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 jupyterlabcodetoc

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 jupyterlabcodetoc within that folder.

Testing the extension

Frontend tests

This extension is using Jest for JavaScript code testing.

To execute them, execute:

jlpm
jlpm test

Integration tests

This extension uses Playwright for the integration tests (aka user level tests). More precisely, the JupyterLab helper Galata is used to handle testing the extension in JupyterLab.

More information are provided within the ui-tests README.

Packaging the extension

See RELEASE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlabcodetoc-4.0.1.tar.gz (306.5 kB view details)

Uploaded Source

Built Distribution

jupyterlabcodetoc-4.0.1-py3-none-any.whl (107.1 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlabcodetoc-4.0.1.tar.gz.

File metadata

  • Download URL: jupyterlabcodetoc-4.0.1.tar.gz
  • Upload date:
  • Size: 306.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.2 CPython/3.11.5

File hashes

Hashes for jupyterlabcodetoc-4.0.1.tar.gz
Algorithm Hash digest
SHA256 7bb471cdd33e6220e83593ec4a54523b3ef57733baaf44142e445277188f2d41
MD5 c2b719b1841ecf699fb796bff229a859
BLAKE2b-256 2b9cec6c5f9586ff3661203bf77ab41dc0a053f10761ad1fd891a437eb8b7bdb

See more details on using hashes here.

File details

Details for the file jupyterlabcodetoc-4.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlabcodetoc-4.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 82bdfc1d91c210fad42c0634a663f3258daaa20b05e0a80386164cfabb5369cb
MD5 43de8af3263599c242659b12c1052bf7
BLAKE2b-256 26152fe41573371c18c5e653348ed46a17f664e0bb671e04c7e80a22d72898dd

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page