Releases: AnswerDotAI/nbdev
Releases · AnswerDotAI/nbdev
v2.3.4
v2.3.3
v2.3.2
v2.3.1
Breaking Changes
_quarto.yml
no longer replaced with automatically generated version (#1059)- This was listed in 2.3.0 but wasn't actually included in the release
Bugs Squashed
- fix
nbdev_update
(#1058), thanks to @seeM- fix bug in
nbdev.maker.update_import
which meant thatnbdev_update
didn't convert relative imports withoutNone
module (e.gfrom . import foo
->from pkg import foo
) - fix
FileNotFoundError
innbdev_update
by passing the correct py module and corresponding notebook paths - fix
nbdev_update
introducing whitespace changes to notebooks
- fix bug in
v2.3.0
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
andcustom_port
insettings.ini
are no longer supported -- use the standard quarto configuration instead
- You can now customise your
- Parallel ipynb filter (#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 ofget_config
(#856), thanks to @seeM
New Features
- Setting
put_version_in_init
to make adding__version__
to__init__.py
optional (#1051), thanks to @MichaelJFishmanBA nbdev_new
support for GitHub Enterprise (#1043), thanks to @seeM- Use
GITHUB_TOKEN
if present fornbdev.release
(#1025) - Support non qmd py rendering scripts (#1014)
- Use penultimate suffix for extension of rendered .py scripts (#1010)
- Print
nbdev_test
cell errors to stderr instead of usinglogging.warning
(#1003) - Make nb meta
display_name
consistent withname
to simplify diffs (#995) - Windows support for clean nb (#989), thanks to @jvanelteren
- Preview support for parallel filter (#976)
- Settings.ini option for choosing preview listen port (#967)
- Authenticate nbdev-template github API call (#940)
- Add
printit
arg tonbdev_filter
so it can be called withfname
and still print to stdout (#931), thanks to @seeM - Run
nbdev_readme
innbdev_new
(#919), thanks to @seeM - Improve config documentation in
read
module (#864), thanks to @seeM - Simplify
jupyter_hooks
configuration (#780), thanks to @seeM
Bugs Squashed
- Class method doclinks target
mod.html#method
instead ofmod.html#class.method
(#1046), thanks to @seeM - "Bad credentials" error in
nbdev_new
if GitHub EnterpriseGH_HOST
andGITHUB_TOKEN
are used (#1038) - Suppress
UserWarning
for unsetGITHUB_TOKEN
innbdev_new
(#1028), thanks to @seeM nbdev.release
usescfg.lib_name
instead ofcfg.repo
(#1024), thanks to @seeMnbdev_test
does not restore the original working directory (#1004)clean_ids
corrupts string outputs (#794), thanks to @seeM
v2.2.10
v2.2.9
New Features
- Experimental: pre-commit hooks (#959), thanks to @seeM
- setup GitHub repo automatically (#955), thanks to @hamelsmu
- Authenticate nbdev-template github API call (#940)
- Support module level docstrings (#473)
Bugs Squashed
show_doc
includes parsed sections from numpy docstrings (#964)AnnAssign
object has no attribute 'targets' (#953)- Exported images not found in docs (#951)
- fix #769 (#946), thanks to @hamelsmu
recursive
in settings.ini ignored (#942)- Wrong source link when using @patch (#939)
- Deploy Action fails with
ModuleNotFoundError: No module named 'https://github'
(#936) - Recursive mode doesn't seem to work when running
nbdev_preview
(#935) - Update All Python Scripts to nbs similar to
nbdev_update_lib
in v1 (#769)
v2.2.7
New Features
- Add
printit
arg tonbdev_filter
so it can be called withfname
and still print to stdout (#931), thanks to @seeM - Run
nbdev_readme
innbdev_new
(#919), thanks to @seeM - In
nbdev_prepare()
auto render README if needed (#913) - Filter keys stored in modidx settings (#903)
- Regression: reintroduce
[source]
link (#692)
Bugs Squashed
- Deploy Action fails with
ModuleNotFoundError: No module named 'https://github'
(#936) - Correct cell index in
nbdev_update
(#934), thanks to @hamelsmu - Handle repo names with dashes and correct index page rendering with file attachments (#930), thanks to @hamelsmu
IPython.display.Image(embed=True)
results in incorrect image reference in GitHub Pages (#924)nbdev_preview
not starting if there is a folder with no notebook in it (#922)- Fix images (#918), thanks to @seeM
nbdev_update
creates a new cell, instead of updating the original code (#775)
v2.2.6
v2.2.0
Breaking Changes
- Combine preprocs and postprocs into new
Processor
class (#874) - Rename
nbdev.read
tonbdev.config
(#879) - Use H3 for functions and properties, instead of H4 (#875)
- Remove
nbflags
directive (#871) - Deprecate
config_key
in favor ofget_config
(#856), thanks to @seeM
New Features
- Add simple qmd generation functions in
nbdev.qmd
(#893) - Add
FrontmatterProc
(#890) - Improvements to
nbdev_new
andnbdev_create_config
(#878), thanks to @seeMnbdev_create_config
infers settings from git/GitHub, prompts for missing settings, and renders the settings file with commented sectionsnbdev_new
usesnbdev_create_config
instead of a file provided bynbdev-template
, which means it'll benefit from future improvements tonbdev_create_config
as well as always using latest defaults
- Add frontmatter bullet point processor (#873)
- Allow specifying port for preview (#872), thanks to @dleen
nbdev_new
renders notebooks with information from your config file (#866), thanks to @seeM- Improve config documentation in
read
module (#864), thanks to @seeM - Install quarto without root access (#860)
- Explain more detail during quarto installation process (#859)
- Automatically maintain
__version__
in__init__.py
(#854) - Prettify output for
nbdev_test
(#849), thanks to @deven367 - Ignore .ipynb_checkpoints folder in module dir (#848), thanks to @dleen
- Escape Footnotes from Docments Table (#847), thanks to @hamelsmu
- Include filename in
nbdev_export
warning when nbdev1 syntax is used (#838), thanks to @seeM - Show title if nbdev_filter errors (#828), thanks to @hamelsmu
- Added "topics" to match GitHub's terminology (#817), thanks to @tylere
- Accelerate
quarto preview
(#748) - Throw a warning when imports and code are mixed in a cell (#714)
- Make conda release work for anyone (#653)
Bugs Squashed
_all_
works for strings but not objects in py3.7 (#870)show_doc
title_level
argument has no effect (#869)show_doc
sometimes does not show wrapped functions correctly (#863)show_doc
treats functions decorated withlru_cache
as classes (#862), thanks to @seeM- Fix
show_doc
signature whitespace removal (#855), thanks to @seeM nbdev_new
doesn't infer anything if no gitconfig (#846)show_doc
paremeter default may render as footnote (#796)- Conda description is empty (#745)