nbdev 3.0.8__tar.gz → 3.0.10__tar.gz

{nbdev-3.0.8/nbdev.egg-info → nbdev-3.0.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.8
+Version: 3.0.10
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0
@@ -58,12 +58,10 @@ Python packaging standards ([PEP
 lives in the standard `[project]` section, while nbdev-specific settings
 go in `[tool.nbdev]`.
 
-**Migrating from nbdev2:** Run
-[`nbdev_migrate_config`](https://nbdev.fast.ai/api/migrate.html#nbdev_migrate_config)
-in your project root to automatically convert your `settings.ini` to
-`pyproject.toml` and update your GitHub Actions workflows to use
-nbdev3-compatible versions. Your existing notebooks and code don’t need
-any changes.
+**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project
+root to automatically convert your `settings.ini` to `pyproject.toml`
+and update your GitHub Actions workflows to use nbdev3-compatible
+versions. Your existing notebooks and code don’t need any changes.
 
 `nbdev` is a notebook-driven development platform. Simply write
 notebooks with lightweight markup and get high-quality documentation,
@@ -86,8 +84,7 @@ practices because tests and documentation are first class.
 - **Two-way sync between notebooks and plaintext source code** allowing
   you to use your IDE for code navigation or quick edits. Sync is
   robust: each exported cell is tagged with its unique notebook cell ID,
-  so [`nbdev_update`](https://nbdev.fast.ai/api/sync.html#nbdev_update)
-  always updates the correct cell
+  so `nbdev-update` always updates the correct cell
 - **Tests** written as ordinary notebook cells are run in parallel with
   a single command
 - **Continuous integration** out-of-the-box with [GitHub
@@ -129,47 +126,47 @@ walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up
 using the `unsilence` Python library – it’s 27 minutes faster, but a bit
 harder to follow.
 
-You can also run `nbdev_help` from the terminal to see the full list of
+You can also run `nbdev-help` from the terminal to see the full list of
 available commands:
 
 ``` python
-!nbdev_help
+!nbdev-help
 ```
 
-    nb_export                 Export a single nbdev notebook to a python script.
-    nbdev_bump_version        Increment version in __init__.py by one
-    nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
-    nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
-    nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
-    nbdev_contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
-    nbdev_create_config       Create a pyproject.toml config file.
-    nbdev_docs                Create Quarto docs and README.md
-    nbdev_export              Export notebooks in `path` to Python modules
-    nbdev_filter              A notebook filter for Quarto
-    nbdev_fix                 Create working notebook from conflicted notebook `nbname`
-    nbdev_help                Show help for all console scripts
-    nbdev_install             Install Quarto and the current library
-    nbdev_install_hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
-    nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
-    nbdev_merge               Git merge driver for notebooks
-    nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
-    nbdev_migrate_config      Migrate settings.ini to pyproject.toml
-    nbdev_new                 Create an nbdev project.
-    nbdev_prepare             Export, test, and clean notebooks, and render README if needed
-    nbdev_preview             Preview docs locally
-    nbdev_proc_nbs            Process notebooks in `path` for docs rendering
-    nbdev_pypi                Create and upload Python package to PyPI
-    nbdev_readme              Create README.md from readme_nb (index.ipynb by default)
-    nbdev_release_both        Release both conda and PyPI packages
-    nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
-    nbdev_release_git         Tag and create a release in GitHub for the current version
-    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
-    nbdev_sidebar             Create sidebar.yml
-    nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust               Trust notebooks matching `fname`.
-    nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
-    nbdev_update_license      Allows you to update the license of your project.
-    watch_export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
+    nb-export                 Export a single nbdev notebook to a python script.
+    nbdev-bump-version        Increment version in __init__.py by one
+    nbdev-changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
+    nbdev-clean               Clean all notebooks in `fname` to avoid merge conflicts
+    nbdev-conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
+    nbdev-contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev-create-config       Create a pyproject.toml config file.
+    nbdev-docs                Create Quarto docs and README.md
+    nbdev-export              Export notebooks in `path` to Python modules
+    nbdev-filter              A notebook filter for Quarto
+    nbdev-fix                 Create working notebook from conflicted notebook `nbname`
+    nbdev-help                Show help for all console scripts
+    nbdev-install             Install Quarto and the current library
+    nbdev-install-hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
+    nbdev-install-quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
+    nbdev-merge               Git merge driver for notebooks
+    nbdev-migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev-migrate-config      Migrate settings.ini to pyproject.toml
+    nbdev-new                 Create an nbdev project.
+    nbdev-prepare             Export, test, and clean notebooks, and render README if needed
+    nbdev-preview             Preview docs locally
+    nbdev-proc-nbs            Process notebooks in `path` for docs rendering
+    nbdev-pypi                Create and upload Python package to PyPI
+    nbdev-readme              Create README.md from readme_nb (index.ipynb by default)
+    nbdev-release-both        Release both conda and PyPI packages
+    nbdev-release-gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
+    nbdev-release-git         Tag and create a release in GitHub for the current version
+    nbdev-requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
+    nbdev-sidebar             Create sidebar.yml
+    nbdev-test                Test in parallel notebooks matching `path`, passing along `flags`
+    nbdev-trust               Trust notebooks matching `fname`.
+    nbdev-update              Propagate change in modules matching `fname` to notebooks that created them
+    nbdev-update-license      Allows you to update the license of your project.
+    watch-export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
 
 ## FAQ
 
@@ -248,8 +245,7 @@ strive to abide by generally accepted best practices in open-source
 software development.
 
 Make sure you have `nbdev`’s git hooks installed by running
-[`nbdev_install_hooks`](https://nbdev.fast.ai/api/clean.html#nbdev_install_hooks)
-in the cloned repository.
+`nbdev-install-hooks` in the cloned repository.
 
 ## Copyright
 

{nbdev-3.0.8 → nbdev-3.0.10}/README.md

@@ -14,12 +14,10 @@ Python packaging standards ([PEP
 lives in the standard `[project]` section, while nbdev-specific settings
 go in `[tool.nbdev]`.
 
-**Migrating from nbdev2:** Run
-[`nbdev_migrate_config`](https://nbdev.fast.ai/api/migrate.html#nbdev_migrate_config)
-in your project root to automatically convert your `settings.ini` to
-`pyproject.toml` and update your GitHub Actions workflows to use
-nbdev3-compatible versions. Your existing notebooks and code don’t need
-any changes.
+**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project
+root to automatically convert your `settings.ini` to `pyproject.toml`
+and update your GitHub Actions workflows to use nbdev3-compatible
+versions. Your existing notebooks and code don’t need any changes.
 
 `nbdev` is a notebook-driven development platform. Simply write
 notebooks with lightweight markup and get high-quality documentation,
@@ -42,8 +40,7 @@ practices because tests and documentation are first class.
 - **Two-way sync between notebooks and plaintext source code** allowing
   you to use your IDE for code navigation or quick edits. Sync is
   robust: each exported cell is tagged with its unique notebook cell ID,
-  so [`nbdev_update`](https://nbdev.fast.ai/api/sync.html#nbdev_update)
-  always updates the correct cell
+  so `nbdev-update` always updates the correct cell
 - **Tests** written as ordinary notebook cells are run in parallel with
   a single command
 - **Continuous integration** out-of-the-box with [GitHub
@@ -85,47 +82,47 @@ walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up
 using the `unsilence` Python library – it’s 27 minutes faster, but a bit
 harder to follow.
 
-You can also run `nbdev_help` from the terminal to see the full list of
+You can also run `nbdev-help` from the terminal to see the full list of
 available commands:
 
 ``` python
-!nbdev_help
+!nbdev-help
 ```
 
-    nb_export                 Export a single nbdev notebook to a python script.
-    nbdev_bump_version        Increment version in __init__.py by one
-    nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
-    nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
-    nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
-    nbdev_contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
-    nbdev_create_config       Create a pyproject.toml config file.
-    nbdev_docs                Create Quarto docs and README.md
-    nbdev_export              Export notebooks in `path` to Python modules
-    nbdev_filter              A notebook filter for Quarto
-    nbdev_fix                 Create working notebook from conflicted notebook `nbname`
-    nbdev_help                Show help for all console scripts
-    nbdev_install             Install Quarto and the current library
-    nbdev_install_hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
-    nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
-    nbdev_merge               Git merge driver for notebooks
-    nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
-    nbdev_migrate_config      Migrate settings.ini to pyproject.toml
-    nbdev_new                 Create an nbdev project.
-    nbdev_prepare             Export, test, and clean notebooks, and render README if needed
-    nbdev_preview             Preview docs locally
-    nbdev_proc_nbs            Process notebooks in `path` for docs rendering
-    nbdev_pypi                Create and upload Python package to PyPI
-    nbdev_readme              Create README.md from readme_nb (index.ipynb by default)
-    nbdev_release_both        Release both conda and PyPI packages
-    nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
-    nbdev_release_git         Tag and create a release in GitHub for the current version
-    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
-    nbdev_sidebar             Create sidebar.yml
-    nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust               Trust notebooks matching `fname`.
-    nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
-    nbdev_update_license      Allows you to update the license of your project.
-    watch_export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
+    nb-export                 Export a single nbdev notebook to a python script.
+    nbdev-bump-version        Increment version in __init__.py by one
+    nbdev-changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
+    nbdev-clean               Clean all notebooks in `fname` to avoid merge conflicts
+    nbdev-conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
+    nbdev-contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev-create-config       Create a pyproject.toml config file.
+    nbdev-docs                Create Quarto docs and README.md
+    nbdev-export              Export notebooks in `path` to Python modules
+    nbdev-filter              A notebook filter for Quarto
+    nbdev-fix                 Create working notebook from conflicted notebook `nbname`
+    nbdev-help                Show help for all console scripts
+    nbdev-install             Install Quarto and the current library
+    nbdev-install-hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
+    nbdev-install-quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
+    nbdev-merge               Git merge driver for notebooks
+    nbdev-migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev-migrate-config      Migrate settings.ini to pyproject.toml
+    nbdev-new                 Create an nbdev project.
+    nbdev-prepare             Export, test, and clean notebooks, and render README if needed
+    nbdev-preview             Preview docs locally
+    nbdev-proc-nbs            Process notebooks in `path` for docs rendering
+    nbdev-pypi                Create and upload Python package to PyPI
+    nbdev-readme              Create README.md from readme_nb (index.ipynb by default)
+    nbdev-release-both        Release both conda and PyPI packages
+    nbdev-release-gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
+    nbdev-release-git         Tag and create a release in GitHub for the current version
+    nbdev-requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
+    nbdev-sidebar             Create sidebar.yml
+    nbdev-test                Test in parallel notebooks matching `path`, passing along `flags`
+    nbdev-trust               Trust notebooks matching `fname`.
+    nbdev-update              Propagate change in modules matching `fname` to notebooks that created them
+    nbdev-update-license      Allows you to update the license of your project.
+    watch-export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
 
 ## FAQ
 
@@ -204,8 +201,7 @@ strive to abide by generally accepted best practices in open-source
 software development.
 
 Make sure you have `nbdev`’s git hooks installed by running
-[`nbdev_install_hooks`](https://nbdev.fast.ai/api/clean.html#nbdev_install_hooks)
-in the cloned repository.
+`nbdev-install-hooks` in the cloned repository.
 
 ## Copyright
 

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "3.0.8"
+__version__ = "3.0.10"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/cli.py

@@ -184,16 +184,16 @@ def watch_export(nbs:str=None, # Nb directory to watch for changes
     lib = lib or (cfg.lib_path if cfg else '.')
     if cfg and (nbs != cfg.nbs_path or lib != cfg.lib_path) and not force:
         raise ValueError("In nbdev project. Use --force to override config.")
-    run(f'nbdev_export')
+    run('nbdev-export')
     def _export(e,lib=lib):
         p = e.src_path
         if (not '.ipynb_checkpoints' in p and p.endswith('.ipynb') and not Path(p).name.startswith(('tmp','.~'))):
             if e.event_type == 'modified':
                 time.sleep(0.1)
-                try: run(f'nb_export --lib_path {lib} "{p}"')
+                try: run(f'nb-export --lib_path {lib} "{p}"')
                 except IOError:
                     time.sleep(0.3)
-                    run(f'nb_export --lib_path {lib} "{p}"')
+                    run(f'nb-export --lib_path {lib} "{p}"')
     with fs_watchdog(_export, nbs):
         while True: time.sleep(1)
 

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/config.py

@@ -152,7 +152,7 @@ def _load_toml(p):
 
 def _has_nbdev(p):
     "True if pyproject.toml at `p` has [tool.nbdev]"
-    try: return bool(_load_toml(p).get('tool', {}).get('nbdev', {}))
+    try: return _load_toml(p).get('tool', {}).get('nbdev') is not None
     except Exception: return False
 
 def _find_nbdev_pyproject(path=None):
@@ -163,11 +163,11 @@ def _find_nbdev_pyproject(path=None):
         if f.exists() and _has_nbdev(f): return f
     for d in [p] + list(p.parents):
         if (d/'settings.ini').exists():
-            raise ValueError(f"Found old settings.ini. Migrate to pyproject.toml using `nbdev_migrate_config`. See https://nbdev.fast.ai/getting_started.html")
+            raise ValueError(f"Found old settings.ini. Migrate to pyproject.toml using `nbdev-migrate-config`. See https://nbdev.fast.ai/getting_started.html")
 
 # %% ../nbs/api/01_config.ipynb #3dac70e0
 nbdev_defaults = dict(nbs_path='nbs', doc_path='_docs', tst_flags='notest', recursive=True, readme_nb='index.ipynb',
-    clean_ids=True, clear_all=False, put_version_in_init=True, jupyter_hooks=False, branch='main',
+    clean_ids=True, clear_all=False, put_version_in_init=True, jupyter_hooks=False, custom_sidebar=False, branch='main',
     doc_procs=[], export_procs=[])
 
 _path_keys = 'lib_path', 'nbs_path', 'doc_path'

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/doclinks.py

@@ -64,7 +64,7 @@ def _iter_py_cells(p):
             nb = ' '.join(parts[:-1])
         else:
             raise ValueError(f"Cell ID required but not found in '{p}' at:\n```\n# %% {top}\n```\n"
-                           "Run `nbdev_export` to regenerate .py files with cell IDs.")
+                           "Run `nbdev-export` to regenerate .py files with cell IDs.")
         if nb=='auto': continue  # Skip auto-generated __all__ cell
         nb_path = (p.parent/nb).resolve()  # NB paths are stored relative to .py file
         if code.endswith('\n'): code=code[:-1]
@@ -147,7 +147,7 @@ def nbdev_export(
     **kwargs):
     "Export notebooks in `path` to Python modules"
     if os.environ.get('IN_TEST',0): return
-    if not is_nbdev(): raise Exception('`nbdev_export` must be called from a directory within a nbdev project.')
+    if not is_nbdev(): raise Exception('`nbdev-export` must be called from a directory within a nbdev project.')
     cfg = get_config()
     procs = procs.split() if procs else cfg.get('export_procs', [])
     procs = [import_obj(p) for p in procs] if procs else None

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/export.py

@@ -53,7 +53,7 @@ def nb_export(nbname:str,        # Filename of notebook
             nm = ifnone(name, getattr(exp, 'default_exp', None) if mod=='#' else mod)
             if not nm:
                 warn(f"Notebook '{nbname}' uses `#| export` without `#| default_exp` cell.\n"
-                     "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
+                     "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev-migrate` to upgrade.\n"
                      "See https://nbdev.fast.ai/getting_started.html for more information.")
                 return
             mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#', solo_nb=solo_nb)

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/quarto.py

@@ -223,7 +223,7 @@ def _doc_mtime_not_older(readme_path, readme_nb_path):
 
 # %% ../nbs/api/14_quarto.ipynb #7b70b5c8
 class _SidebarYmlRemoved:
-    "Context manager for `nbdev_readme` to avoid rendering whole docs website"
+    "Context manager for `nbdev-readme` to avoid rendering whole docs website"
     def __init__(self,path): self._path=path
     def __enter__(self):
         self._yml_path = self._path/'sidebar.yml'

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/release.py

@@ -127,7 +127,7 @@ def release_git(token:str=None):
 def release_gh(
     token:str=None  # Optional GitHub token (otherwise `token` file is used)
 ):
-    "Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`"
+    "Calls `nbdev-changelog`, lets you edit the result, then pushes to git and calls `nbdev-release-git`"
     cfg = _find_config()
     Release().changelog()
     subprocess.run([os.environ.get('EDITOR','nano'), cfg.config_path/'CHANGELOG.md'])

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/sync.py

@@ -73,7 +73,7 @@ def _update_mod(py_path, lib_dir):
 @call_parse
 def nbdev_update(fname:str=None): # A Python file name to update
     "Propagate change in modules matching `fname` to notebooks that created them"
-    if fname and fname.endswith('.ipynb'): raise ValueError("`nbdev_update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev_export`.")
+    if fname and fname.endswith('.ipynb'): raise ValueError("`nbdev-update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev-export`.")
     if os.environ.get('IN_TEST',0): return
     cfg = get_config()
     fname = Path(fname or cfg.lib_path)

{nbdev-3.0.8 → nbdev-3.0.10}/nbdev/test.py

@@ -28,7 +28,8 @@ def test_nb(fn,  # file name of notebook to test
             force_flags=None,  # list of flags marking cells to always run
             do_print=False,  # print completion?
             showerr=True,  # print errors to stderr?
-            basepath=None):  # path to add to sys.path
+            basepath=None,  # path to add to sys.path
+            verbose=False):  # stream stdout/stderr from cells to console?
     "Execute tests in notebook in `fn` except those with `skip_flags`"
     if basepath: sys.path.insert(0, str(basepath))
     if not IN_NOTEBOOK: os.environ["IN_TEST"] = '1'
@@ -49,7 +50,7 @@ def test_nb(fn,  # file name of notebook to test
     if do_print: print(f'Starting {fn}')
     try:
         with working_directory(fn.parent):
-            k.run_all(nb, exc_stop=True, preproc=_no_eval)
+            k.run_all(nb, exc_stop=True, preproc=_no_eval, verbose=verbose)
             res = True
     except: 
         if showerr: sys.stderr.write(k.prettytb(fname=fn)+'\n')
@@ -76,6 +77,7 @@ def nbdev_test(
     do_print:bool=False, # Print start and end of each notebook
     pause:float=0.01,  # Pause time (in seconds) between notebooks to avoid race conditions
     ignore_fname:str='.notest', # Filename that will result in siblings being ignored
+    verbose:bool=False, # Print stdout/stderr from notebook cells?
     **kwargs):
     "Test in parallel notebooks matching `path`, passing along `flags`"
     skip_flags = get_config().tst_flags
@@ -90,7 +92,7 @@ def nbdev_test(
     wd_pth = get_config().nbs_path
     with working_directory(wd_pth if (wd_pth and wd_pth.exists()) else os.getcwd()):
         results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers,
-                           basepath=get_config().config_path, pause=pause, do_print=do_print, **kw)
+                           basepath=get_config().config_path, pause=pause, do_print=do_print, verbose=verbose, **kw)
     passed,times = zip(*results)
     if all(passed): print("Success.")
     else: 

{nbdev-3.0.8 → nbdev-3.0.10/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.8
+Version: 3.0.10
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0
@@ -58,12 +58,10 @@ Python packaging standards ([PEP
 lives in the standard `[project]` section, while nbdev-specific settings
 go in `[tool.nbdev]`.
 
-**Migrating from nbdev2:** Run
-[`nbdev_migrate_config`](https://nbdev.fast.ai/api/migrate.html#nbdev_migrate_config)
-in your project root to automatically convert your `settings.ini` to
-`pyproject.toml` and update your GitHub Actions workflows to use
-nbdev3-compatible versions. Your existing notebooks and code don’t need
-any changes.
+**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project
+root to automatically convert your `settings.ini` to `pyproject.toml`
+and update your GitHub Actions workflows to use nbdev3-compatible
+versions. Your existing notebooks and code don’t need any changes.
 
 `nbdev` is a notebook-driven development platform. Simply write
 notebooks with lightweight markup and get high-quality documentation,
@@ -86,8 +84,7 @@ practices because tests and documentation are first class.
 - **Two-way sync between notebooks and plaintext source code** allowing
   you to use your IDE for code navigation or quick edits. Sync is
   robust: each exported cell is tagged with its unique notebook cell ID,
-  so [`nbdev_update`](https://nbdev.fast.ai/api/sync.html#nbdev_update)
-  always updates the correct cell
+  so `nbdev-update` always updates the correct cell
 - **Tests** written as ordinary notebook cells are run in parallel with
   a single command
 - **Continuous integration** out-of-the-box with [GitHub
@@ -129,47 +126,47 @@ walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up
 using the `unsilence` Python library – it’s 27 minutes faster, but a bit
 harder to follow.
 
-You can also run `nbdev_help` from the terminal to see the full list of
+You can also run `nbdev-help` from the terminal to see the full list of
 available commands:
 
 ``` python
-!nbdev_help
+!nbdev-help
 ```
 
-    nb_export                 Export a single nbdev notebook to a python script.
-    nbdev_bump_version        Increment version in __init__.py by one
-    nbdev_changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
-    nbdev_clean               Clean all notebooks in `fname` to avoid merge conflicts
-    nbdev_conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
-    nbdev_contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
-    nbdev_create_config       Create a pyproject.toml config file.
-    nbdev_docs                Create Quarto docs and README.md
-    nbdev_export              Export notebooks in `path` to Python modules
-    nbdev_filter              A notebook filter for Quarto
-    nbdev_fix                 Create working notebook from conflicted notebook `nbname`
-    nbdev_help                Show help for all console scripts
-    nbdev_install             Install Quarto and the current library
-    nbdev_install_hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
-    nbdev_install_quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
-    nbdev_merge               Git merge driver for notebooks
-    nbdev_migrate             Convert all markdown and notebook files in `path` from v1 to v2
-    nbdev_migrate_config      Migrate settings.ini to pyproject.toml
-    nbdev_new                 Create an nbdev project.
-    nbdev_prepare             Export, test, and clean notebooks, and render README if needed
-    nbdev_preview             Preview docs locally
-    nbdev_proc_nbs            Process notebooks in `path` for docs rendering
-    nbdev_pypi                Create and upload Python package to PyPI
-    nbdev_readme              Create README.md from readme_nb (index.ipynb by default)
-    nbdev_release_both        Release both conda and PyPI packages
-    nbdev_release_gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
-    nbdev_release_git         Tag and create a release in GitHub for the current version
-    nbdev_requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
-    nbdev_sidebar             Create sidebar.yml
-    nbdev_test                Test in parallel notebooks matching `path`, passing along `flags`
-    nbdev_trust               Trust notebooks matching `fname`.
-    nbdev_update              Propagate change in modules matching `fname` to notebooks that created them
-    nbdev_update_license      Allows you to update the license of your project.
-    watch_export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
+    nb-export                 Export a single nbdev notebook to a python script.
+    nbdev-bump-version        Increment version in __init__.py by one
+    nbdev-changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
+    nbdev-clean               Clean all notebooks in `fname` to avoid merge conflicts
+    nbdev-conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
+    nbdev-contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev-create-config       Create a pyproject.toml config file.
+    nbdev-docs                Create Quarto docs and README.md
+    nbdev-export              Export notebooks in `path` to Python modules
+    nbdev-filter              A notebook filter for Quarto
+    nbdev-fix                 Create working notebook from conflicted notebook `nbname`
+    nbdev-help                Show help for all console scripts
+    nbdev-install             Install Quarto and the current library
+    nbdev-install-hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
+    nbdev-install-quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
+    nbdev-merge               Git merge driver for notebooks
+    nbdev-migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev-migrate-config      Migrate settings.ini to pyproject.toml
+    nbdev-new                 Create an nbdev project.
+    nbdev-prepare             Export, test, and clean notebooks, and render README if needed
+    nbdev-preview             Preview docs locally
+    nbdev-proc-nbs            Process notebooks in `path` for docs rendering
+    nbdev-pypi                Create and upload Python package to PyPI
+    nbdev-readme              Create README.md from readme_nb (index.ipynb by default)
+    nbdev-release-both        Release both conda and PyPI packages
+    nbdev-release-gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
+    nbdev-release-git         Tag and create a release in GitHub for the current version
+    nbdev-requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
+    nbdev-sidebar             Create sidebar.yml
+    nbdev-test                Test in parallel notebooks matching `path`, passing along `flags`
+    nbdev-trust               Trust notebooks matching `fname`.
+    nbdev-update              Propagate change in modules matching `fname` to notebooks that created them
+    nbdev-update-license      Allows you to update the license of your project.
+    watch-export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
 
 ## FAQ
 
@@ -248,8 +245,7 @@ strive to abide by generally accepted best practices in open-source
 software development.
 
 Make sure you have `nbdev`’s git hooks installed by running
-[`nbdev_install_hooks`](https://nbdev.fast.ai/api/clean.html#nbdev_install_hooks)
-in the cloned repository.
+`nbdev-install-hooks` in the cloned repository.
 
 ## Copyright