nbdev-sphinx

library0.0.2398pypypiunverified

nbdev-sphinx provides Sphinx extensions for nbdev, enabling automatic documentation of Jupyter notebooks and Python libraries. It offers directives to include notebook outputs, search notebook metadata, and integrate with fastai's nbdev workflow. Current version: 0.0.2398.

web-framework data

pip install nbdev-sphinx

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · NBDEV-SPHINX

nbdev-sphinx

web-frameworkpythonv0.0.2398

Install

2.3s avg

Import

—

Disk

17MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.0.2398 · 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 · 18.7MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 2.3s · import 0.000s · 19MB

17MB installed

● package 17MB

Code

Verified usage

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

NbdevDoc

✓ from nbdev_sphinx import NbdevDoc

✗ from nbdev_sphinx import NbdevDoc

Basic usage: add 'nbdev_sphinx' to Sphinx extensions in conf.py. The NbdevDoc class can be used programmatically to generate documentation.

from nbdev_sphinx import NbdevDoc from sphinx.application import Sphinx # Example usage in conf.py: # extensions = ['nbdev_sphinx'] # nbdev_doc = NbdevDoc() # nbdev_sphinx_show_doc = True

Debug

Known issues

deprecatedPython 3.6 support is deprecated. Requires Python >=3.6, but current best practice is Python >=3.8.

fix

Upgrade Python to 3.8 or higher.

affects: 0.0.2398

gotchaThe library uses nbdev_index to lookup documentation; if the index is not built, imports may silently fail.

fix

Run 'nbdev_build_lib' and 'nbdev_build_docs' before building Sphinx docs.

affects: all

breakingIn version 0.0.23xx, the module was renamed from 'nbdev_sphinx' to 'nbdev_sphinx' but the import path changed. Check your conf.py.

fix

Use 'from nbdev_sphinx import ...' instead of old import paths.

affects: >=0.0.2300

Upgrade

Version history

0.0.2398latest on PyPI · released Feb 9, 2026

Audit

Dependencies

sphinxrequiredCore extension framework

nbdevrequiredRequired for notebook parsing and metadata lookups

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/fastai/nbdev-index ↗

packagehttps://pypi.org/project/nbdev-sphinx/ ↗

homepagehttps://nbdev.fast.ai ↗