Nbdev Versions Save

Bugs Squashed

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

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)

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)

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

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)

New Features

• add nbdev_conda to create and upload conda packages (#850)

New Features

• Add custom_quarto_yml setting (#842), thanks to @benoit-cty
• Display multiline docstrings (#841)
• Include filename in nbdev_export warning when nbdev1 syntax is used (#835)
• Streamline nbdev_new: outputs are now in color, you can pass --lib_name, and it calls nbdev_export (#820), thanks to @seeM
• A command for uploading to the test pypi server (#818), thanks to @tourdownunder
• Include notebook title in nbdev_preview error message (#802)
• Migrate collapsible code cell directives (#783), thanks to @hamelsmu
• Simplify jupyter_hooks configuration (#780), thanks to @seeM
• Support nbdev_install_hooks in non-nbdev repos (#779), thanks to @seeM
• Allow users to provide user-level settings in ~/.config/nbdev/settings.ini (#778), thanks to @seeM
• Support nbdev_install_hooks in non-nbdev repos (#777)
• Port doc() from nbdev1 (#772)
• Make show_doc for function parameter defaults concise and deterministic (#771)
• Clean id from text repr outputs to further avoid git merge conflicts (#749)
• Add repo root to sys path on exec (#735)
• Use frontmatter eval and showdoc for controlling notebook execution (#734)

Bugs Squashed

• #|exports directive does not show source code in the docs (#822)
• nbdev commands fail when doc_path contains whitespace (#813), thanks to @mone27
• show_doc html renderer is incorrectly formatted (#808)
• show_doc cell output is incorrectly styled (#807)
• links aren't rendered as code (#795), thanks to @seeM
• clean_ids corrupts string outputs (#794), thanks to @seeM
• quarto frontmatter is removed (#789)
• nbdev_merge fails on git stash pop conflict (#787), thanks to @seeM
• Hooks search Jupyter start directory instead of notebook directory for settings file (#784), thanks to @dleen
• Allow for dash in Quarto directives (#782), thanks to @hamelsmu
• Fix directive migration when there is no test flag (#781), thanks to @hamelsmu
• nbdev_prepare throws BrokenProcessPool error on MacOS (#731)
• settings.ini not inferred by nbdev_new on newly cloned repo on MacOS (#710)

New Features

• use global defaults instead of respecifying each time (#770), thanks to @seeM
• get_config works without a settings file (#768), thanks to @seeM
• add site url (#767), thanks to @hamelsmu
• add show_src to display rich source code (#763), thanks to @seeM
• add support for #|exports (#762)
• nbdev_merge prints info like git merge (#753)
• helpers to convert fp front matter to quarto front matter (#750), thanks to @hamelsmu
• Streamline default settings (#747)
• Config keys (and their defaults) should all be documented in one place
• add user option to jupyter_hooks setting (#738), thanks to @seeM
• Add appropriate output-file to existing frontmatter (#728)

Bugs Squashed

• nbdev_prepare sometimes throws BrokenProcessPool error on MacOS (#731)
• Incorrect relative import from package root inside nested module (#773)
• Jupyter hooks break in environments without nbdev installed (#760)
• nbdev_fix breaks with empty ours patch (#752)
• fix nbdev_merge during rebase; fix nbdev_fix nobackup default (#737), thanks to @seeM
• non-notebooks do not have nbformat field (#732), thanks to @dleen

New Features

• add tools from fastrelease to nbdev (#733)

Bugs Squashed

• fix nbdev_test with no --fname in non-nbdev repos (#730), thanks to @seeM
• Auto-generated showdoc headers not in ToC (#703)

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