How answerdotai/nbdev works
nbdev is a notebook-driven development platform: developers author notebooks, export notebook cells into Python modules, and generate documentation and other project outputs. Its major capabilities also include syncing module edits back into notebooks, notebook testing and cleanup, merge support, configuration migration, and release tooling. The graph emphasizes those documented stages; several subsystem links are based on README capabilities because their implementations were not sampled.
Main entry points: cli.py CLI commands · export.py Notebook export · quarto.py Quarto integration · nbs Project notebooks
Components 23
Notebook authoring
- Project notebooks
nbs - Project configuration
nbdev/config.py
Export and sync
- Notebook export
nbdev/export.py - Notebook processor
nbdev/process.py - Cell processors
nbdev/processors.py - Module maker
nbdev/maker.py - Notebook sync
nbdev/sync.py
Documentation
- Documentation index
nbdev/doclinks.py - API documentation
nbdev/showdoc.py - Frontmatter processing
nbdev/frontmatter.py - Quarto integration
nbdev/quarto.py - Quarto rendering
nbdev/quarto_render.py
Project workflows
- CLI commands
nbdev/cli.py - Notebook cleanup
nbdev/clean.py - Notebook merge
nbdev/merge.py - Notebook diff
nbdev/diff.py - Notebook tests
nbdev/test.py - Project migration
nbdev/migrate.py - Package release
nbdev/release.py
Other components
- Developer
- Quarto
- PyPI and conda
- GitHub Pages
Connections 24
- Developer → Project notebooks: authors
README.md - Developer → CLI commands: runs commands
README.md - CLI commands → Project configuration: reads settings
nbdev/cli.py - CLI commands → Notebook export: invokes export
nbdev/cli.py - Notebook export → Notebook processor: processes notebook
nbdev/export.py - Notebook export → Module maker: creates modules
nbdev/export.py - Notebook processor → Cell processors: runs processors
nbdev/processors.py - Project notebooks → Notebook export: exports cells
README.md - Developer → Notebook sync: syncs edits
README.md - Notebook sync → Project notebooks: updates cells
nbdev/sync.py - CLI commands → Documentation index: builds index
nbdev/cli.py - Documentation index → Notebook export: exports notebooks
nbdev/doclinks.py - Project notebooks → Frontmatter processing: provides metadata
- CLI commands → Quarto integration: builds docs
nbdev/cli.py - Quarto integration → Quarto rendering: renders notebooks
nbdev/quarto.py - Quarto integration → Quarto: runs renderer
nbdev/quarto.py - Quarto integration → GitHub Pages: publishes docs
README.md - CLI commands → Notebook cleanup: cleans notebooks
nbdev/cli.py - Developer → Notebook merge: resolves conflicts
README.md - Developer → Notebook diff: compares notebooks
README.md - CLI commands → Notebook tests: runs tests
nbdev/cli.py - Developer → Project migration: migrates project
README.md - Developer → Package release: releases package
README.md - Package release → PyPI and conda: publishes packages
README.md