Registry / web-framework / nbsphinx-link

nbsphinx-link

library1.4.1pypypiunverified

A Sphinx extension for including Jupyter notebook files that reside outside the Sphinx source root directory. Current version 1.3.1, supports Python 3+, released under BSD license. Releases are infrequent, last updated in 2021.

web-framework

pip install nbsphinx-link

github ↗package ↗

INSTALL

IMPORT

SIG · NBSPHINX-LINK

nbsphinx-link

web-frameworkpythonv1.4.1

Install

8.8s avg

Import

—

Disk

117MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.4.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 115.1MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 8.8s · import 0.000s · 112MB

117MB installed

● package 117MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

nbsphinx_link

✓ extensions = ['nbsphinx_link']

✗ extensions = ['nbsphinx-link']

Use underscore not hyphen in Sphinx extensions list

Basic setup in Sphinx conf.py

# In conf.py import os import sys sys.path.insert(0, os.path.abspath('.')) extensions = ['nbsphinx', 'nbsphinx_link'] # Create a symlink or use nbsphinx-link targets # Example: create a symlink to an external notebook # os.symlink('/path/to/external/notebook.ipynb', 'linked_notebook.ipynb')

Debug

Known issues

breakingnbsphinx-link 1.0.0 changed the extension name from 'nbsphinx_link' (with underscore) to 'nbsphinx_link' (still underscore, but note: older docs sometimes used hyphen in configuration). Ensure you use underscore in Sphinx extensions list.

fix

Use 'nbsphinx_link' in extensions list, not 'nbsphinx-link'.

affects: >=1.0.0

gotchaNotebooks must be placed relative to source directory or linked via symlinks. The extension does not handle absolute paths outside the source root automatically.

fix

Use symlinks or place notebooks in a subdirectory of your source root, or configure via nbsphinx_link_targets.

affects: all

deprecatedThe extension is in maintenance mode; no new features. Sphinx 4+ compatibility is reported but not actively tested.

fix

Consider alternatives like 'jupyter-sphinx' or direct symlink management.

affects: all

Upgrade

Version history

1.4.1latest on PyPI · released May 29, 2026

Audit

Dependencies

nbsphinxrequiredRequired for processing notebooks

sphinxrequiredRequired extension framework

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/vidartf/nbsphinx-link ↗

packagehttps://pypi.org/project/nbsphinx-link/ ↗