Skip to content

Releases: AnswerDotAI/nbdev

v2.3.4

16 Sep 23:44
Compare
Choose a tag to compare

New Features

Bugs Squashed

v2.3.3

16 Sep 00:21
Compare
Choose a tag to compare

New Features

v2.3.2

15 Sep 09:01
Compare
Choose a tag to compare

New Features

  • Support GitHub Enterprise (#944)

Bugs Squashed

  • nbdev_new fails with AttributeError: path_ (#1063)

v2.3.1

14 Sep 19:23
Compare
Choose a tag to compare

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 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

v2.3.0

14 Sep 05:44
Compare
Choose a tag to compare

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)
    • 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), 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 for nbdev.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 using logging.warning (#1003)
  • Make nb meta display_name consistent with name 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 to nbdev_filter so it can be called with fname and still print to stdout (#931), thanks to @seeM
  • Run nbdev_readme in nbdev_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 of mod.html#class.method (#1046), thanks to @seeM
  • "Bad credentials" error in nbdev_new if GitHub Enterprise GH_HOST and GITHUB_TOKEN are used (#1038)
  • Suppress UserWarning for unset GITHUB_TOKEN in nbdev_new (#1028), thanks to @seeM
  • nbdev.release uses cfg.lib_name instead of cfg.repo (#1024), thanks to @seeM
  • nbdev_test does not restore the original working directory (#1004)
  • clean_ids corrupts string outputs (#794), thanks to @seeM

v2.2.10

01 Sep 17:29
Compare
Choose a tag to compare

Bugs Squashed

  • missing doc_path.name in _docs move (#973)

v2.2.9

01 Sep 17:18
Compare
Choose a tag to compare

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

26 Aug 01:44
Compare
Choose a tag to compare

New Features

  • Add printit arg to nbdev_filter so it can be called with fname and still print to stdout (#931), thanks to @seeM
  • Run nbdev_readme in nbdev_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

21 Aug 01:17
Compare
Choose a tag to compare

New Features

  • Build _modidx.py on demand in order to git conflicts (#911)
  • Add source link to index (#909)
  • Order left navigation sections using numeric prefix (#901)
  • Automatic rendering of python files with frontmatter (#895)

Bugs Squashed

  • Make sure #|exec_doc triggers an update even when there is no export or show_doc (#906), thanks to @hamelsmu
  • allow nbdev directives to work with cell magic (#905), thanks to @hamelsmu

v2.2.0

18 Aug 02:44
Compare
Choose a tag to compare

Breaking Changes

  • Combine preprocs and postprocs into new Processor class (#874)
  • Rename nbdev.read to nbdev.config (#879)
  • Use H3 for functions and properties, instead of H4 (#875)
  • Remove nbflags directive (#871)
  • Deprecate config_key in favor of get_config (#856), thanks to @seeM

New Features

  • Add simple qmd generation functions in nbdev.qmd (#893)
  • Add FrontmatterProc (#890)
  • Improvements to nbdev_new and nbdev_create_config (#878), thanks to @seeM
    • nbdev_create_config infers settings from git/GitHub, prompts for missing settings, and renders the settings file with commented sections
    • nbdev_new uses nbdev_create_config instead of a file provided by nbdev-template, which means it'll benefit from future improvements to nbdev_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 with lru_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)