{"id":24102,"library":"nbsphinx-link","title":"nbsphinx-link","description":"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.","status":"maintenance","version":"1.3.1","language":"python","source_language":"en","source_url":"https://github.com/vidartf/nbsphinx-link","tags":["sphinx","jupyter","notebook","documentation","extension"],"install":[{"cmd":"pip install nbsphinx-link","lang":"bash","label":"PyPI install"}],"dependencies":[{"reason":"Required for processing notebooks","package":"nbsphinx","optional":false},{"reason":"Required extension framework","package":"sphinx","optional":false}],"imports":[{"note":"Use underscore not hyphen in Sphinx extensions list","wrong":"extensions = ['nbsphinx-link']","symbol":"nbsphinx_link","correct":"extensions = ['nbsphinx_link']"}],"quickstart":{"code":"# In conf.py\nimport os\nimport sys\nsys.path.insert(0, os.path.abspath('.'))\nextensions = ['nbsphinx', 'nbsphinx_link']\n# Create a symlink or use nbsphinx-link targets\n# Example: create a symlink to an external notebook\n# os.symlink('/path/to/external/notebook.ipynb', 'linked_notebook.ipynb')","lang":"python","description":"Basic setup in Sphinx conf.py"},"warnings":[{"fix":"Use 'nbsphinx_link' in extensions list, not 'nbsphinx-link'.","message":"nbsphinx-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.","severity":"breaking","affected_versions":">=1.0.0"},{"fix":"Use symlinks or place notebooks in a subdirectory of your source root, or configure via nbsphinx_link_targets.","message":"Notebooks must be placed relative to source directory or linked via symlinks. The extension does not handle absolute paths outside the source root automatically.","severity":"gotcha","affected_versions":"all"},{"fix":"Consider alternatives like 'jupyter-sphinx' or direct symlink management.","message":"The extension is in maintenance mode; no new features. Sphinx 4+ compatibility is reported but not actively tested.","severity":"deprecated","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Change 'nbsphinx-link' to 'nbsphinx_link' in conf.py extensions list.","cause":"Hyphen used instead of underscore in Sphinx extensions list","error":"WARNING: unknown extension: nbsphinx-link"},{"fix":"Create a symlink from source directory to the notebook, or place notebook inside source root.","cause":"Trying to reference notebook with absolute path outside source directory without symlink","error":"Error: Notebook file not found: /absolute/path/to/notebook.ipynb"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}