Skip to content

Latest commit

 

History

History
340 lines (191 loc) · 13.4 KB

CHANGELOG.md

File metadata and controls

340 lines (191 loc) · 13.4 KB
Raw

Release notes

2.1.0

Breaking Changes

  • nbdev_sidebar now looks for .qmd files instead of .md files

New Features

  • automatically add output:asis for showdoc cells (#726)
  • accelerate nbdev_readme (#715)
  • deterministic show_doc and DocmentTbl repr (#707), thanks to @seeM

Bugs Squashed

  • KeyError 'repo' when trying to create a new nbdev project with nbdev_new (#720)
  • show_doc ends the details column at any | character (#712)
  • only add to .gitattributes if missing (#706), thanks to @seeM

2.0.7

New Features

  • git merge hooks: automatically resolve conflicts and render markers as separate cells (#704), thanks to @seeM
  • Allow clean to keep some metadata keys (#672), thanks to @dleen
  • enable mac terminal install instead of visual installer (#705), thanks to @hamelsmu
  • Conditional content for markdown vs HTML for README (#694), thanks to @hamelsmu
  • Export a single module (#652)

Bugs Squashed

  • Re-enable Mac CI #425)

2.0.6

New Features

  • new jupyter save hook to clean NBs (#697), thanks to @seeM
  • new directive exec_doc to auto-exec cell when building docs (#699)
  • automatically escape YAML strings for title and description in frontmatter (#691)
  • add unbump param to nbdev_bump_version (#689)
  • install ghapi automatically (#690)

2.0.5

New Features

  • add nbdev_readme (#688)

2.0.4

New Features

  • add readme_nb config option (#668)

Bugs Squashed

  • exporti cells can cause showdocs exec to fail (#679)
  • missing .html suffix in links (#674)
  • Add early return (#670), thanks to @dleen

2.0.0

  • From-scratch rewrite of nbdev! nbdev now uses Quarto to create beautiful and full-featured websites
  • nbdev2 is much faster than previous versions
  • Note that you should run nbdev_migrate_directives after upgrading to use the new comment directive format (e.g #| export instead of #export)

1.2.11

New Features

  • support py310 style union annotations (#636), thanks to @seeM

Bugs Squashed

  • fix show_doc for properties (#635), thanks to @seeM
  • nbdev_nb2md throws error when called in a notebook (#381)

1.2.10

New Features

Bugs Squashed

1.2.9

New Features

  • Implement show_doc for dataclass (#622), thanks to @MarkB2

Bugs Squashed

  • Fix show doc for object, class methods. (#621), thanks to @v-ahuja
  • Fix show doc for keywords. (#619), thanks to @v-ahuja
  • Including @dataclass breaks nbdev_build_lib (#595)
  • nbdev_nb2md throws error when called in a notebook (#381)

1.2.7

Bugs Squashed

  • Don't build NBs with no #default_exp

1.2.6

New Features

  • nbdev_build_libs now works on a single file even without a settings.ini or any #default_exp cell
  • Handle #| as directive prefix

Bugs Squashed

  • nbdev_nb2md throws error when called in a notebook (#381)

1.2.5

New Features

  • Update dependencies

1.2.3

Bugs Squashed

  • Pin jinja2 due to deprecation bug in nbconvert

1.2.2

New Features

  • Update dependencies

1.2.1

New Features

  • Make sure docments have linking capability (#585), thanks to @muellerzr
  • better logging for duplicate titles (#584), thanks to @hamelsmu

Bugs Squashed

1.2.0

  • upgrade nbconvert dep to v6

1.1.23

Bugs Squashed

  • fix verbose flag

1.1.20

New Features

  • skip symlinks in recursive glob (#515)

1.1.15

Breaking Changes

  • make recursive behavior for nbdev_build_docs consistent with nbdev_build_lib (#467), thanks to @hamelsmu

New Features

  • Allow for a one-time only (potentially) .py -> .ipynb generation (#369)

Bugs Squashed

  • Images with attachment: break export (#501), thanks to @yacchin1205
  • Docs nav doesn't work on gitlab (#488), thanks to @tcapelle
  • clean up all instances of recursive (#470), thanks to @hamelsmu
  • After 'conda install -c fastai nbdev', error "HTMLExporter object has no attribute template_path" (#431)

1.1.13

New Features

  • support windows (#392), thanks to @mszhanyi
  • nbdev_new: get template from latest release asset (#382), thanks to @hamelsmu
  • Add more license options

Bugs Squashed

  • Fix recursive flag (#433), thanks to @hamelsmu
  • conda not installing nbdev properly on WSL2 (#430)
  • fix nb2md (#424), thanks to @hamelsmu
  • nbdev_build_lib seems to convert more notebooks than expected (#423)
  • fix default arg issue with nbdev_update_lib (#416), thanks to @hamelsmu
  • nbdev_update_lib errors out when fname not supplied (#415)
  • nbdev_new fails on calling the GitHub API without guidance (#404)
  • fix recurse issue (#391), thanks to @hamelsmu
  • nbdev_build_docs----ModuleNotFoundError: No module named 'fastcore' (#390)
  • nbdev_test_nbs --fname broke in 1.1.7 (#388)
  • set recursive=True for docs (#387), thanks to @hamelsmu
  • fix url for getting branch (#386), thanks to @hamelsmu
  • nbdev_nb2md throws error when called in a notebook (#381)

1.1.12

New Features

  • nbdev_new should grab files from a release asset in nbdev_template (#383)
  • Use Jekyll Theme instead of vendoring all required files (#379)
  • Create relevant directories in docs/_data if do not already exist (#377)

1.1.6

New Features

  • Clean Google Colab metadata and line endings (#364), thanks to @muellerzr
  • add ability to find notebooks recursively (#359), thanks to @hamelsmu
  • Add bare flag to nbdev_build_lib (#336)
  • install git hooks in nbdev_new (#308)
  • nbdev_new now works on an existing cloned repo, instead of creating a new repo (#307)

Bugs Squashed

  • nbdev_update_lib --fname notebook.ipynb crashes (while nbdev_update_lib works) (#341)
  • Copy new files only if they don't exist for nbdev_new (#309)

1.1.3

New Features

  • Place source code below heading on #exports (#265), thanks to @hamelsmu

1.1.2

Bugs Squashed

  • update fastcore requirement (#281)

1.1.1

New Features

  • Make CLI faster by removing unneeded imports and moving CLI commands to source modules (#271)
  • Move Config to fastcore (#280)

1.1.0

Breaking Changes

  • Remove magics (#269)
  • Removed callbacks (#253), thanks to @pete88b
  • move conda packager to fastrelease (#252)

New Features

  • Place source code below heading on #exports (#265), thanks to @hamelsmu
  • always skip cells labeled "skip" in test (#257)

1.0.17

Bugs Squashed

  • restrict nbconvert<6 to avoid upgrade problems (#249)

1.0.16

Bugs Squashed

  • When generating docs, import cells are run even if not exported (#248)

1.0.15

New Features

  • add option to not exec nb for fastpages (#244)
  • Enable Codespaces for nbdev (#243)

Bugs Squashed

  • Fix: correct notebook2html path operation for Windows. (#239)

1.0.13

New Features

  • remove numpy conda dep and update to fastcore 1.0.5 (#241)

Bugs Squashed

  • allow nbdev imports when not in an nbdev project (#238)

1.0.10

New Features

  • Magic flags for tests (#232)
  • Add ability to have Colab badges on pages (#210)
  • Support for doc_path (#235)

Bugs Squashed

  • Remove colab vendor specific tags which cause nbdev_build_docs to fail (#207)
  • hooks folder inside .git must be manually created before nbdev_install_git_hooks (#230)
  • updates to how backtick names are converted to doc links (#218)

Version 1.0.0

  • Initial release