Nbdev

Breaking Changes

- `_quarto.yml` no longer replaced with automatically generated version ([1059](https://github.com/fastai/nbdev/issues/1059))
- This was listed in 2.3.0 but wasn't actually included in the release

Bugs Squashed

- fix `nbdev_update` ([1058](https://github.com/fastai/nbdev/pull/1058)), thanks to [seeM](https://github.com/seeM)
- fix bug in `nbdev.maker.update_import` which meant that `nbdev_update` didn't convert relative imports without `None` module (e.g `from . import foo` -> `from pkg import foo`)
- fix `FileNotFoundError` in `nbdev_update` by passing the correct py module and corresponding notebook paths
- fix `nbdev_update` introducing whitespace changes to notebooks

Breaking Changes

- `_quarto.yml` no longer replaced with automatically generated version
- You can now customise your `_quarto.yml` file and it will not be overridden by nbdev
- This means that `custom_host` and `custom_port` in `settings.ini` are no longer supported -- use the standard quarto configuration instead
- Parallel ipynb filter ([961](https://github.com/fastai/nbdev/issues/961))
- `ipynb-filters` in `_quarto.yml` is no longer needed or recommended. Instead, nbdev preprocesses your notebooks in parallel into a folder called `_proc` before calling quarto
- The new processing system generally results in speedups of around 10x compared to the previous approach
- Deprecate `config_key` in favor of `get_config` ([856](https://github.com/fastai/nbdev/pull/856)), thanks to [seeM](https://github.com/seeM)

New Features

- Setting `put_version_in_init ` to make adding `__version__` to `__init__.py` optional ([1051](https://github.com/fastai/nbdev/pull/1051)), thanks to [MichaelJFishmanBA](https://github.com/MichaelJFishmanBA)
- `nbdev_new` support for GitHub Enterprise ([1043](https://github.com/fastai/nbdev/pull/1043)), thanks to [seeM](https://github.com/seeM)
- Use `GITHUB_TOKEN` if present for `nbdev.release` ([1025](https://github.com/fastai/nbdev/issues/1025))
- Support non qmd py rendering scripts ([1014](https://github.com/fastai/nbdev/issues/1014))
- Use penultimate suffix for extension of rendered .py scripts ([1010](https://github.com/fastai/nbdev/issues/1010))
- Print `nbdev_test` cell errors to stderr instead of using `logging.warning` ([1003](https://github.com/fastai/nbdev/issues/1003))
- Make nb meta `display_name` consistent with `name` to simplify diffs ([995](https://github.com/fastai/nbdev/issues/995))
- Windows support for clean nb ([989](https://github.com/fastai/nbdev/pull/989)), thanks to [jvanelteren](https://github.com/jvanelteren)
- Preview support for parallel filter ([976](https://github.com/fastai/nbdev/issues/976))
- Settings.ini option for choosing preview listen port ([967](https://github.com/fastai/nbdev/issues/967))
- Vscode extension for nbdev which cleans notebooks ([952](https://github.com/fastai/nbdev/issues/952))
- Authenticate nbdev-template github API call ([940](https://github.com/fastai/nbdev/issues/940))
- Add `printit` arg to `nbdev_filter` so it can be called with `fname` and still print to stdout ([931](https://github.com/fastai/nbdev/pull/931)), thanks to [seeM](https://github.com/seeM)
- Run `nbdev_readme` in `nbdev_new` ([919](https://github.com/fastai/nbdev/pull/919)), thanks to [seeM](https://github.com/seeM)
- Improve config documentation in `read` module ([864](https://github.com/fastai/nbdev/pull/864)), thanks to [seeM](https://github.com/seeM)
- Simplify `jupyter_hooks` configuration ([780](https://github.com/fastai/nbdev/pull/780)), thanks to [seeM](https://github.com/seeM)

Bugs Squashed

- Class method doclinks target `mod.htmlmethod` instead of `mod.htmlclass.method` ([1046](https://github.com/fastai/nbdev/pull/1046)), thanks to [seeM](https://github.com/seeM)
- "Bad credentials" error in `nbdev_new` if GitHub Enterprise `GH_HOST` and `GITHUB_TOKEN` are used ([1038](https://github.com/fastai/nbdev/issues/1038))
- Suppress `UserWarning` for unset `GITHUB_TOKEN` in `nbdev_new` ([1028](https://github.com/fastai/nbdev/pull/1028)), thanks to [seeM](https://github.com/seeM)
- `nbdev.release` uses `cfg.lib_name` instead of `cfg.repo` ([1024](https://github.com/fastai/nbdev/pull/1024)), thanks to [seeM](https://github.com/seeM)
- `nbdev_test` does not restore the original working directory ([1004](https://github.com/fastai/nbdev/issues/1004))
- `clean_ids` corrupts string outputs ([794](https://github.com/fastai/nbdev/pull/794)), thanks to [seeM](https://github.com/seeM)

Bugs Squashed

- missing `doc_path.name` in `_docs` move ([973](https://github.com/fastai/nbdev/issues/973))

New Features

- Experimental: pre-commit hooks ([959](https://github.com/fastai/nbdev/pull/959)), thanks to [seeM](https://github.com/seeM)
- setup GitHub repo automatically ([955](https://github.com/fastai/nbdev/pull/955)), thanks to [hamelsmu](https://github.com/hamelsmu)
- Authenticate nbdev-template github API call ([940](https://github.com/fastai/nbdev/issues/940))
- Support module level docstrings ([473](https://github.com/fastai/nbdev/issues/473))

Bugs Squashed

- `show_doc` includes parsed sections from numpy docstrings ([964](https://github.com/fastai/nbdev/issues/964))
- `AnnAssign` object has no attribute 'targets' ([953](https://github.com/fastai/nbdev/issues/953))
- Exported images not found in docs ([951](https://github.com/fastai/nbdev/issues/951))
- fix 769 ([946](https://github.com/fastai/nbdev/pull/946)), thanks to [hamelsmu](https://github.com/hamelsmu)
- `recursive` in settings.ini ignored ([942](https://github.com/fastai/nbdev/issues/942))
- Wrong source link when using patch ([939](https://github.com/fastai/nbdev/issues/939))
- Deploy Action fails with `ModuleNotFoundError: No module named 'https://github'` ([#936](https://github.com/fastai/nbdev/issues/936))
- Recursive mode doesn't seem to work when running `nbdev_preview` ([935](https://github.com/fastai/nbdev/issues/935))
- Update All Python Scripts to nbs similar to `nbdev_update_lib` in v1 ([769](https://github.com/fastai/nbdev/issues/769))

New Features

- Add `printit` arg to `nbdev_filter` so it can be called with `fname` and still print to stdout ([931](https://github.com/fastai/nbdev/pull/931)), thanks to [seeM](https://github.com/seeM)
- Run `nbdev_readme` in `nbdev_new` ([919](https://github.com/fastai/nbdev/pull/919)), thanks to [seeM](https://github.com/seeM)
- In `nbdev_prepare()` auto render README if needed ([913](https://github.com/fastai/nbdev/issues/913))
- Filter keys stored in modidx settings ([903](https://github.com/fastai/nbdev/issues/903))
- Regression: reintroduce `[source]` link ([692](https://github.com/fastai/nbdev/issues/692))

Bugs Squashed

- Deploy Action fails with `ModuleNotFoundError: No module named 'https://github'` ([#936](https://github.com/fastai/nbdev/issues/936))
- Correct cell index in `nbdev_update` ([934](https://github.com/fastai/nbdev/pull/934)), thanks to [hamelsmu](https://github.com/hamelsmu)
- Handle repo names with dashes and correct index page rendering with file attachments ([930](https://github.com/fastai/nbdev/pull/930)), thanks to [hamelsmu](https://github.com/hamelsmu)
- `IPython.display.Image(embed=True)` results in incorrect image reference in GitHub Pages ([924](https://github.com/fastai/nbdev/issues/924))
- `nbdev_preview` not starting if there is a folder with no notebook in it ([922](https://github.com/fastai/nbdev/issues/922))
- Fix images ([918](https://github.com/fastai/nbdev/pull/918)), thanks to [seeM](https://github.com/seeM)
- `nbdev_update` creates a new cell, instead of updating the original code ([775](https://github.com/fastai/nbdev/issues/775))

New Features

- Build `_modidx.py` on demand in order to git conflicts ([911](https://github.com/fastai/nbdev/issues/911))
- Add source link to index ([909](https://github.com/fastai/nbdev/issues/909))
- Order left navigation sections using numeric prefix ([901](https://github.com/fastai/nbdev/issues/901))
- Automatic rendering of python files with frontmatter ([895](https://github.com/fastai/nbdev/issues/895))

Bugs Squashed

- Make sure `|exec_doc` triggers an update even when there is no export or show_doc ([906](https://github.com/fastai/nbdev/pull/906)), thanks to [hamelsmu](https://github.com/hamelsmu)
- allow nbdev directives to work with cell magic ([905](https://github.com/fastai/nbdev/pull/905)), thanks to [hamelsmu](https://github.com/hamelsmu)