{"id":24101,"library":"nbdev-sphinx","title":"nbdev-sphinx","description":"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.","status":"active","version":"0.0.2398","language":"python","source_language":"en","source_url":"https://github.com/fastai/nbdev-index/tree/master/","tags":["nbdev","sphinx","documentation","jupyter","fastai"],"install":[{"cmd":"pip install nbdev-sphinx","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Core extension framework","package":"sphinx","optional":false},{"reason":"Required for notebook parsing and metadata lookups","package":"nbdev","optional":false}],"imports":[{"note":"Wrong parent package","wrong":"from nbdev.sphinx import NbdevDoc","symbol":"NbdevDoc","correct":"from nbdev_sphinx import NbdevDoc"},{"note":"Direct import from module, not submodule","wrong":"from nbdev_sphinx.search import NbdevSearch","symbol":"NbdevSearch","correct":"from nbdev_sphinx import NbdevSearch"}],"quickstart":{"code":"from nbdev_sphinx import NbdevDoc\nfrom sphinx.application import Sphinx\n# Example usage in conf.py:\n# extensions = ['nbdev_sphinx']\n# nbdev_doc = NbdevDoc()\n# nbdev_sphinx_show_doc = True","lang":"python","description":"Basic usage: add 'nbdev_sphinx' to Sphinx extensions in conf.py. The NbdevDoc class can be used programmatically to generate documentation."},"warnings":[{"fix":"Upgrade Python to 3.8 or higher.","message":"Python 3.6 support is deprecated. Requires Python >=3.6, but current best practice is Python >=3.8.","severity":"deprecated","affected_versions":"0.0.2398"},{"fix":"Run 'nbdev_build_lib' and 'nbdev_build_docs' before building Sphinx docs.","message":"The library uses nbdev_index to lookup documentation; if the index is not built, imports may silently fail.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'from nbdev_sphinx import ...' instead of old import paths.","message":"In version 0.0.23xx, the module was renamed from 'nbdev_sphinx' to 'nbdev_sphinx' but the import path changed. Check your conf.py.","severity":"breaking","affected_versions":">=0.0.2300"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install nbdev-sphinx' in the correct environment.","cause":"nbdev-sphinx not installed or wrong Python environment.","error":"ModuleNotFoundError: No module named 'nbdev_sphinx'"},{"fix":"Use 'from nbdev_sphinx import NbdevDoc' after upgrading to the latest version.","cause":"Incorrect import or old version of nbdev-sphinx.","error":"AttributeError: module 'nbdev_sphinx' has no attribute 'NbdevDoc'"},{"fix":"Run 'nbdev_build_lib' and 'nbdev_build_docs' in your project root.","cause":"nbdev index not built or missing.","error":"WARNING: nbdev_index not found"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}