fixes #699

Author: jph00

nbdev/_modidx.py

@@ -12,7 +12,6 @@
                                    'nbdev_trust=nbdev.clean:nbdev_trust\n'
                                    'nbdev_clean=nbdev.clean:nbdev_clean\n'
                                    'nbdev_install_hooks=nbdev.clean:nbdev_install_hooks\n'
-                                   'nbdev_install_jupyter_hooks=nbdev.clean:nbdev_install_jupyter_hooks\n'
                                    'nbdev_filter=nbdev.cli:nbdev_filter\n'
                                    'nbdev_quarto=nbdev.cli:nbdev_quarto\n'
                                    'nbdev_ghp_deploy=nbdev.cli:nbdev_ghp_deploy\n'
@@ -51,7 +50,7 @@
                 'readme_nb': 'getting_started.ipynb',
                 'recursive': 'False',
                 'repo': 'nbdev',
-                'requirements': 'fastcore>=1.5.8 execnb astunparse ghapi',
+                'requirements': 'fastcore>=1.5.11 execnb astunparse ghapi',
                 'status': '2',
                 'title': 'nbdev',
                 'tst_flags': 'notest',
@@ -61,7 +60,6 @@
                              'nbdev.clean.clean_nb': 'https://nbdev.fast.ai/clean.html#clean_nb',
                              'nbdev.clean.nbdev_clean': 'https://nbdev.fast.ai/clean.html#nbdev_clean',
                              'nbdev.clean.nbdev_install_hooks': 'https://nbdev.fast.ai/clean.html#nbdev_install_hooks',
-                             'nbdev.clean.nbdev_install_jupyter_hooks': 'https://nbdev.fast.ai/clean.html#nbdev_install_jupyter_hooks',
                              'nbdev.clean.nbdev_trust': 'https://nbdev.fast.ai/clean.html#nbdev_trust',
                              'nbdev.clean.process_write': 'https://nbdev.fast.ai/clean.html#process_write'},
             'nbdev.cli': { 'nbdev.cli.FilterDefaults': 'https://nbdev.fast.ai/cli.html#filterdefaults',

nbdev/clean.py

@@ -1,8 +1,7 @@
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/11_clean.ipynb.
 
 # %% auto 0
-__all__ = ['nbdev_trust', 'clean_nb', 'process_write', 'nbdev_clean', 'nbdev_install_hooks', 'clean_jupyter',
-           'nbdev_install_jupyter_hooks']
+__all__ = ['nbdev_trust', 'clean_nb', 'process_write', 'nbdev_clean', 'clean_jupyter', 'nbdev_install_hooks']
 
 # %% ../nbs/11_clean.ipynb 2
 import warnings,stat
@@ -121,40 +120,6 @@ def nbdev_clean(
     for f in globtastic(fname, file_glob='*.ipynb', skip_folder_re='^[_.]'): _write(f_in=f, disp=disp)
 
 # %% ../nbs/11_clean.ipynb 24
-@call_parse
-def nbdev_install_hooks():
-    "Install git hooks to clean and trust notebooks automatically"
-    nb_path = config_key("nbs_path", '.')
-    path = get_config().config_path
-    hook_path = path/'.git'/'hooks'
-    fn = hook_path/'post-merge'
-    hook_path.mkdir(parents=True, exist_ok=True)
-    fn.write_text("#!/bin/bash\nnbdev_trust")
-    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)
-    #Clean notebooks on commit/diff
-    (path/'.gitconfig').write_text("""# Generated by nbdev_install_hooks
-#
-# If you need to disable this instrumentation do:
-#   git config --local --unset include.path
-#
-# To restore the filter
-#   git config --local include.path .gitconfig
-#
-# If you see notebooks not stripped, checked the filters are applied in .gitattributes
-#
-[filter "clean-nbs"]
-        clean = nbdev_clean --stdin
-        smudge = cat
-        required = true
-[diff "ipynb"]
-        textconv = nbdev_clean --disp --fname
-""")
-    cmd = "git config --local include.path ../.gitconfig"
-    run(cmd)
-    print("Hooks are installed and repo's .gitconfig is now trusted")
-    (nb_path/'.gitattributes').write_text("**/*.ipynb filter=clean-nbs\n**/*.ipynb diff=ipynb\n")
-
-# %% ../nbs/11_clean.ipynb 25
 def clean_jupyter(path, model, **kwargs):
     "Clean Jupyter `model` pre save to `path`"
     get_config.cache_clear() # Reset Jupyter's cache
@@ -165,17 +130,17 @@ def clean_jupyter(path, model, **kwargs):
     is_nb_v4 = (model['type'],model['content']['nbformat']) == ('notebook',4)
     if in_nbdev_repo and jupyter_hooks and is_nb_v4: _nbdev_clean(model['content'])
 
-# %% ../nbs/11_clean.ipynb 27
+# %% ../nbs/11_clean.ipynb 26
 def _nested_setdefault(o, attr, default):
     "Same as `setdefault`, but if `attr` includes a `.`, then looks inside nested objects"
     attrs = attr.split('.')
     for a in attrs[:-1]: o = o.setdefault(a, type(o)())
     return o.setdefault(attrs[-1], default)
 
-# %% ../nbs/11_clean.ipynb 31
+# %% ../nbs/11_clean.ipynb 30
 @call_parse
-def nbdev_install_jupyter_hooks():
-    "Install Jupyter hooks to clean notebooks on save"
+def nbdev_install_hooks():
+    "Install Jupyter and git hooks to clean notebooks on save and trust notebooks automatically"
     cfg_path = Path.home()/'.jupyter'
     cfg_fns = [cfg_path/f'jupyter_{o}_config.json' for o in ('notebook','server')]
     attr,hook = 'ContentsManager.pre_save_hook','nbdev.clean.clean_jupyter'
@@ -188,3 +153,12 @@ def nbdev_install_jupyter_hooks():
         elif val != hook:
             sys.stderr.write(f"Can't install hook to '{p}' since it already contains `{attr} = '{val}'`. "
                              f"Manually update to `{attr} = '{hook}'` for this functionality.")
+
+    nb_path = config_key("nbs_path", '.')
+    path = get_config().config_path
+    hook_path = path/'.git'/'hooks'
+    fn = hook_path/'post-merge'
+    hook_path.mkdir(parents=True, exist_ok=True)
+    fn.write_text("#!/bin/bash\nnbdev_trust")
+    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)
+    print("Hooks are installed.")

nbdev/processors.py

@@ -121,7 +121,7 @@ def clean_show_doc(cell):
 def _show_docs(trees):
     return [t for t in trees if isinstance(t,ast.Expr) and nested_attr(t, 'value.func.id')=='show_doc']
 
-_show_dirs = {'export','exports','exporti'}
+_show_dirs = {'export','exports','exporti','exec_doc'}
 
 def _do_eval(cell):
     if cell_lang(cell) != 'python': return

nbs/09_processors.ipynb

@@ -439,7 +439,7 @@
     "def _show_docs(trees):\n",
     "    return [t for t in trees if isinstance(t,ast.Expr) and nested_attr(t, 'value.func.id')=='show_doc']\n",
     "\n",
-    "_show_dirs = {'export','exports','exporti'}\n",
+    "_show_dirs = {'export','exports','exporti','exec_doc'}\n",
     "\n",
     "def _do_eval(cell):\n",
     "    if cell_lang(cell) != 'python': return\n",

nbs/11_clean.ipynb

@@ -326,47 +326,6 @@
     "```"
    ]
   },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": [
-    "#|export\n",
-    "@call_parse\n",
-    "def nbdev_install_hooks():\n",
-    "    \"Install git hooks to clean and trust notebooks automatically\"\n",
-    "    nb_path = config_key(\"nbs_path\", '.')\n",
-    "    path = get_config().config_path\n",
-    "    hook_path = path/'.git'/'hooks'\n",
-    "    fn = hook_path/'post-merge'\n",
-    "    hook_path.mkdir(parents=True, exist_ok=True)\n",
-    "    fn.write_text(\"#!/bin/bash\\nnbdev_trust\")\n",
-    "    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)\n",
-    "    #Clean notebooks on commit/diff\n",
-    "    (path/'.gitconfig').write_text(\"\"\"# Generated by nbdev_install_hooks\n",
-    "#\n",
-    "# If you need to disable this instrumentation do:\n",
-    "#   git config --local --unset include.path\n",
-    "#\n",
-    "# To restore the filter\n",
-    "#   git config --local include.path .gitconfig\n",
-    "#\n",
-    "# If you see notebooks not stripped, checked the filters are applied in .gitattributes\n",
-    "#\n",
-    "[filter \"clean-nbs\"]\n",
-    "        clean = nbdev_clean --stdin\n",
-    "        smudge = cat\n",
-    "        required = true\n",
-    "[diff \"ipynb\"]\n",
-    "        textconv = nbdev_clean --disp --fname\n",
-    "\"\"\")\n",
-    "    cmd = \"git config --local include.path ../.gitconfig\"\n",
-    "    run(cmd)\n",
-    "    print(\"Hooks are installed and repo's .gitconfig is now trusted\")\n",
-    "    (nb_path/'.gitattributes').write_text(\"**/*.ipynb filter=clean-nbs\\n**/*.ipynb diff=ipynb\\n\")"
-   ]
-  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -389,7 +348,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "`clean_jupyter` implements Jupyter's [`ContentsManager.pre_save_hook`](https://jupyter-notebook.readthedocs.io/en/6.4.12/extending/savehooks.html). The easiest way to install it as a Jupyter Notebook or Lab pre-save hook is by running  `nbdev_install_jupyter_hooks`."
+    "`clean_jupyter` implements Jupyter's [`ContentsManager.pre_save_hook`](https://jupyter-notebook.readthedocs.io/en/6.4.12/extending/savehooks.html). The easiest way to install it as a Jupyter Notebook or Lab pre-save hook is by running  `nbdev_install_hooks`."
    ]
   },
   {
@@ -450,8 +409,8 @@
    "source": [
     "#|export\n",
     "@call_parse\n",
-    "def nbdev_install_jupyter_hooks():\n",
-    "    \"Install Jupyter hooks to clean notebooks on save\"\n",
+    "def nbdev_install_hooks():\n",
+    "    \"Install Jupyter and git hooks to clean notebooks on save and trust notebooks automatically\"\n",
     "    cfg_path = Path.home()/'.jupyter'\n",
     "    cfg_fns = [cfg_path/f'jupyter_{o}_config.json' for o in ('notebook','server')]\n",
     "    attr,hook = 'ContentsManager.pre_save_hook','nbdev.clean.clean_jupyter'\n",
@@ -463,7 +422,16 @@
     "            fn.write_text(dumps(obj2dict(cfg), indent=2))\n",
     "        elif val != hook:\n",
     "            sys.stderr.write(f\"Can't install hook to '{p}' since it already contains `{attr} = '{val}'`. \"\n",
-    "                             f\"Manually update to `{attr} = '{hook}'` for this functionality.\")"
+    "                             f\"Manually update to `{attr} = '{hook}'` for this functionality.\")\n",
+    "\n",
+    "    nb_path = config_key(\"nbs_path\", '.')\n",
+    "    path = get_config().config_path\n",
+    "    hook_path = path/'.git'/'hooks'\n",
+    "    fn = hook_path/'post-merge'\n",
+    "    hook_path.mkdir(parents=True, exist_ok=True)\n",
+    "    fn.write_text(\"#!/bin/bash\\nnbdev_trust\")\n",
+    "    os.chmod(fn, os.stat(fn).st_mode | stat.S_IEXEC)\n",
+    "    print(\"Hooks are installed.\")"
    ]
   },
   {
@@ -487,8 +455,7 @@
    "outputs": [],
    "source": [
     "#|hide\n",
-    "#|eval:false\n",
-    "from nbdev.doclinks import nbdev_export\n",
+    "from nbdev import nbdev_export\n",
     "nbdev_export()"
    ]
   },

nbs/getting_started.ipynb

@@ -145,6 +145,7 @@
     }
    ],
    "source": [
+    "#| exec_doc\n",
     "!nbdev_help"
    ]
   },

settings.ini

@@ -31,7 +31,6 @@ console_scripts = nbdev_create_config=nbdev.read:nbdev_create_config
 	nbdev_trust=nbdev.clean:nbdev_trust
 	nbdev_clean=nbdev.clean:nbdev_clean
 	nbdev_install_hooks=nbdev.clean:nbdev_install_hooks
-	nbdev_install_jupyter_hooks=nbdev.clean:nbdev_install_jupyter_hooks
 	nbdev_filter=nbdev.cli:nbdev_filter
 	nbdev_quarto=nbdev.cli:nbdev_quarto
 	nbdev_ghp_deploy=nbdev.cli:nbdev_ghp_deploy