nbdev-extensions

A collection of useful extensions for nbdev I’ve thought of

These extensions will have niche use cases in some places, however these are ones where I find a benefit in having them at least once. Also known as, cool ideas myself or others have considered with nbdev brought to life

Install

pip install nbdev-extensions

How to use

To enable any of these extensions, in your settings.ini make sure to:

  1. Add nbdev-extensions as a requirement
  2. Add procs = nbdev_extensions.codenotes:NoteExportProc, where it should point to the exact function being called

Features

nbdev-extensions currently has the following features:

  • new_nb - A CLI/functional interface to quickly generate blank template notebooks for nbdev development with all of the necessary boilerplate cells prefilled based on the passed parameters.

  • Code Notes - A note-taking annotation tool utilizing nbdev to write quick comments and explanations for sections of code in a code cell without cluttering the code cell with comments. These show up as panels in the rendered documentation, one with just the source code and the other with the source and an explanation

  • Tag Maker - A quick way to annotate ::: {something} ... ::: by writing it as a directive (#| layout something)