fixes #688

Author: jph00

nbdev/_modidx.py

@@ -29,6 +29,7 @@
                                    'nbdev_conda=nbdev.shortcuts:conda\n'
                                    'nbdev_release=nbdev.shortcuts:release\n'
                                    'nbdev_prepare=nbdev.shortcuts:prepare\n'
+                                   'nbdev_readme=nbdev.cli:nbdev_readme\n'
                                    'nbdev_help=nbdev.shortcuts:chelp',
                 'copyright': '2020 onwards, Jeremy Howard',
                 'custom_sidebar': 'True',
@@ -75,6 +76,7 @@
                            'nbdev.cli.nbdev_ghp_deploy': 'https://nbdev.fast.ai/cli.html#nbdev_ghp_deploy',
                            'nbdev.cli.nbdev_new': 'https://nbdev.fast.ai/cli.html#nbdev_new',
                            'nbdev.cli.nbdev_quarto': 'https://nbdev.fast.ai/cli.html#nbdev_quarto',
+                           'nbdev.cli.nbdev_readme': 'https://nbdev.fast.ai/cli.html#nbdev_readme',
                            'nbdev.cli.nbdev_sidebar': 'https://nbdev.fast.ai/cli.html#nbdev_sidebar',
                            'nbdev.cli.prompt_user': 'https://nbdev.fast.ai/cli.html#prompt_user',
                            'nbdev.cli.refresh_quarto_yml': 'https://nbdev.fast.ai/cli.html#refresh_quarto_yml',

nbdev/cli.py

@@ -21,7 +21,8 @@
 
 # %% auto 0
 __all__ = ['nbdev_ghp_deploy', 'nbdev_sidebar', 'FilterDefaults', 'nbdev_filter', 'update_version', 'bump_version',
-           'nbdev_bump_version', 'extract_tgz', 'prompt_user', 'refresh_quarto_yml', 'nbdev_new', 'nbdev_quarto']
+           'nbdev_bump_version', 'extract_tgz', 'prompt_user', 'refresh_quarto_yml', 'nbdev_new', 'nbdev_readme',
+           'nbdev_quarto']
 
 # %% ../nbs/10_cli.ipynb 5
 @call_parse
@@ -59,7 +60,7 @@ def nbdev_sidebar(
 ):
     "Create sidebar.yml"
     if not force and str2bool(config_key('custom_sidebar', path=False)): return
-    path = config_key("nbs_path") if not path else Path(path)
+    path = config_key("nbs_path", ".") if not path else Path(path)
     files = nbglob(path, func=_f, symlinks=symlinks, file_re=file_re, folder_re=folder_re, file_glob=file_glob,
                    skip_file_glob=skip_file_glob, skip_file_re=skip_file_re, skip_folder_re=skip_folder_re).sorted(key=_sort)
     lastd,res = Path(),[]
@@ -301,6 +302,30 @@ def _sprun(cmd):
     except subprocess.CalledProcessError as cpe: sys.exit(cpe.returncode)
 
 # %% ../nbs/10_cli.ipynb 26
+def _doc_paths(path:str=None, doc_path:str=None):
+    cfg = get_config()
+    cfg_path = cfg.config_path
+    path = config_key("nbs_path", ".") if not path else Path(path)
+    doc_path = config_key("doc_path") if not doc_path else Path(doc_path)
+    tmp_doc_path = path/f"{cfg['doc_path']}"
+    return cfg,cfg_path,path,doc_path,tmp_doc_path
+
+# %% ../nbs/10_cli.ipynb 27
+@call_parse
+def nbdev_readme(
+    path:str=None, # Path to notebooks
+    doc_path:str=None): # Path to output docs
+    "Render README.md from index.ipynb"
+    cfg,cfg_path,path,doc_path,tmp_doc_path = _doc_paths(path, doc_path)
+    idx_path = path/config_key('readme_nb', 'index.ipynb', path=False)
+    if idx_path.exists(): 
+        _sprun(f'cd {path} && quarto render {idx_path} -o README.md -t gfm --no-execute')
+    if (tmp_doc_path/'README.md').exists():
+        _rdm = cfg_path/'README.md'
+        if _rdm.exists(): _rdm.unlink() # py37 doesn't have arg missing_ok so have to check first
+        shutil.move(str(tmp_doc_path/'README.md'), cfg_path) # README.md is temporarily in nbs/_docs
+
+# %% ../nbs/10_cli.ipynb 28
 @call_parse
 def nbdev_quarto(
     path:str=None, # Path to notebooks
@@ -313,27 +338,15 @@ def nbdev_quarto(
     preview:bool=False # Preview the site instead of building it
 ):
     "Create Quarto docs and README.md"
-    cfg = get_config()
-    cfg_path = cfg.config_path
+    cfg,cfg_path,path,doc_path,tmp_doc_path = _doc_paths(path, doc_path)
     refresh_quarto_yml()
-    path = config_key("nbs_path") if not path else Path(path)
-    idx_path = path/config_key('readme_nb', 'index.ipynb', path=False)
     files = nbdev_sidebar.__wrapped__(path, symlinks=symlinks, file_re=file_re, folder_re=folder_re,
                             skip_file_glob=skip_file_glob, skip_file_re=skip_file_re, returnit=True)
-    doc_path = config_key("doc_path") if not doc_path else Path(doc_path)
-    tmp_doc_path = config_key('nbs_path')/f"{cfg['doc_path']}"
     shutil.rmtree(doc_path, ignore_errors=True)
     cmd = 'preview' if preview else 'render'
     _sprun(f'cd {path} && quarto {cmd} --no-execute')
     if not preview:
-        if idx_path.exists(): 
-            _sprun(f'cd {path} && quarto render {idx_path} -o README.md -t gfm --no-execute')
-
-        if (tmp_doc_path/'README.md').exists():
-            _rdm = cfg_path/'README.md'
-            if _rdm.exists(): _rdm.unlink() #py 3.7 doesn't have arg missing_ok so have to check first
-            shutil.move(str(tmp_doc_path/'README.md'), cfg_path) # README.md is temporarily in nbs/_docs
-
+        nbdev_readme.__wrapped__(path, doc_path)
         if tmp_doc_path.parent != cfg_path: # move docs folder to root of repo if it doesn't exist there
             shutil.rmtree(doc_path, ignore_errors=True)
             shutil.move(tmp_doc_path, cfg_path)

nbdev/doclinks.py

@@ -117,7 +117,7 @@ def build_modidx():
     dest = config_key('lib_path')
     if os.environ.get('IN_TEST',0): return
     _fn = dest/'_modidx.py'
-    nbs_path = config_key('nbs_path')
+    nbs_path = config_key('nbs_path', '.')
     files = globtastic(nbs_path)
     with contextlib.suppress(FileNotFoundError): _fn.unlink()
     cfg = get_config()

nbdev/test.py

@@ -82,7 +82,7 @@ def nbdev_test(
         print('No files were eligible for testing')
         return
     if n_workers is None: n_workers = 0 if len(files)==1 else min(num_cpus(), 8)
-    os.chdir(config_key("nbs_path"))
+    os.chdir(config_key("nbs_path", "."))
     results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers, pause=pause, do_print=do_print)
     passed,times = zip(*results)
     if all(passed): print("Success.")

nbs/04b_doclinks.ipynb

@@ -394,7 +394,7 @@
     "    dest = config_key('lib_path')\n",
     "    if os.environ.get('IN_TEST',0): return\n",
     "    _fn = dest/'_modidx.py'\n",
-    "    nbs_path = config_key('nbs_path')\n",
+    "    nbs_path = config_key('nbs_path', '.')\n",
     "    files = globtastic(nbs_path)\n",
     "    with contextlib.suppress(FileNotFoundError): _fn.unlink()\n",
     "    cfg = get_config()\n",

nbs/10_cli.ipynb

@@ -116,7 +116,7 @@
     "):\n",
     "    \"Create sidebar.yml\"\n",
     "    if not force and str2bool(config_key('custom_sidebar', path=False)): return\n",
-    "    path = config_key(\"nbs_path\") if not path else Path(path)\n",
+    "    path = config_key(\"nbs_path\", \".\") if not path else Path(path)\n",
     "    files = nbglob(path, func=_f, symlinks=symlinks, file_re=file_re, folder_re=folder_re, file_glob=file_glob,\n",
     "                   skip_file_glob=skip_file_glob, skip_file_re=skip_file_re, skip_folder_re=skip_folder_re).sorted(key=_sort)\n",
     "    lastd,res = Path(),[]\n",
@@ -517,6 +517,46 @@
     "    except subprocess.CalledProcessError as cpe: sys.exit(cpe.returncode)"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "5192dfae",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "def _doc_paths(path:str=None, doc_path:str=None):\n",
+    "    cfg = get_config()\n",
+    "    cfg_path = cfg.config_path\n",
+    "    path = config_key(\"nbs_path\", \".\") if not path else Path(path)\n",
+    "    doc_path = config_key(\"doc_path\") if not doc_path else Path(doc_path)\n",
+    "    tmp_doc_path = path/f\"{cfg['doc_path']}\"\n",
+    "    return cfg,cfg_path,path,doc_path,tmp_doc_path"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "4e995496",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "@call_parse\n",
+    "def nbdev_readme(\n",
+    "    path:str=None, # Path to notebooks\n",
+    "    doc_path:str=None): # Path to output docs\n",
+    "    \"Render README.md from index.ipynb\"\n",
+    "    cfg,cfg_path,path,doc_path,tmp_doc_path = _doc_paths(path, doc_path)\n",
+    "    idx_path = path/config_key('readme_nb', 'index.ipynb', path=False)\n",
+    "    if idx_path.exists(): \n",
+    "        _sprun(f'cd {path} && quarto render {idx_path} -o README.md -t gfm --no-execute')\n",
+    "    if (tmp_doc_path/'README.md').exists():\n",
+    "        _rdm = cfg_path/'README.md'\n",
+    "        if _rdm.exists(): _rdm.unlink() # py37 doesn't have arg missing_ok so have to check first\n",
+    "        shutil.move(str(tmp_doc_path/'README.md'), cfg_path) # README.md is temporarily in nbs/_docs"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -537,27 +577,15 @@
     "    preview:bool=False # Preview the site instead of building it\n",
     "):\n",
     "    \"Create Quarto docs and README.md\"\n",
-    "    cfg = get_config()\n",
-    "    cfg_path = cfg.config_path\n",
+    "    cfg,cfg_path,path,doc_path,tmp_doc_path = _doc_paths(path, doc_path)\n",
     "    refresh_quarto_yml()\n",
-    "    path = config_key(\"nbs_path\") if not path else Path(path)\n",
-    "    idx_path = path/config_key('readme_nb', 'index.ipynb', path=False)\n",
     "    files = nbdev_sidebar.__wrapped__(path, symlinks=symlinks, file_re=file_re, folder_re=folder_re,\n",
     "                            skip_file_glob=skip_file_glob, skip_file_re=skip_file_re, returnit=True)\n",
-    "    doc_path = config_key(\"doc_path\") if not doc_path else Path(doc_path)\n",
-    "    tmp_doc_path = config_key('nbs_path')/f\"{cfg['doc_path']}\"\n",
     "    shutil.rmtree(doc_path, ignore_errors=True)\n",
     "    cmd = 'preview' if preview else 'render'\n",
     "    _sprun(f'cd {path} && quarto {cmd} --no-execute')\n",
     "    if not preview:\n",
-    "        if idx_path.exists(): \n",
-    "            _sprun(f'cd {path} && quarto render {idx_path} -o README.md -t gfm --no-execute')\n",
-    "\n",
-    "        if (tmp_doc_path/'README.md').exists():\n",
-    "            _rdm = cfg_path/'README.md'\n",
-    "            if _rdm.exists(): _rdm.unlink() #py 3.7 doesn't have arg missing_ok so have to check first\n",
-    "            shutil.move(str(tmp_doc_path/'README.md'), cfg_path) # README.md is temporarily in nbs/_docs\n",
-    "\n",
+    "        nbdev_readme.__wrapped__(path, doc_path)\n",
     "        if tmp_doc_path.parent != cfg_path: # move docs folder to root of repo if it doesn't exist there\n",
     "            shutil.rmtree(doc_path, ignore_errors=True)\n",
     "            shutil.move(tmp_doc_path, cfg_path)"

nbs/14_test.ipynb

@@ -189,7 +189,7 @@
     "        print('No files were eligible for testing')\n",
     "        return\n",
     "    if n_workers is None: n_workers = 0 if len(files)==1 else min(num_cpus(), 8)\n",
-    "    os.chdir(config_key(\"nbs_path\"))\n",
+    "    os.chdir(config_key(\"nbs_path\", \".\"))\n",
     "    results = parallel(test_nb, files, skip_flags=skip_flags, force_flags=force_flags, n_workers=n_workers, pause=pause, do_print=do_print)\n",
     "    passed,times = zip(*results)\n",
     "    if all(passed): print(\"Success.\")\n",

settings.ini

@@ -48,6 +48,7 @@ console_scripts = nbdev_create_config=nbdev.read:nbdev_create_config
 	nbdev_conda=nbdev.shortcuts:conda
 	nbdev_release=nbdev.shortcuts:release
 	nbdev_prepare=nbdev.shortcuts:prepare
+	nbdev_readme=nbdev.cli:nbdev_readme
 	nbdev_help=nbdev.shortcuts:chelp
 tst_flags = notest
 nbs_path = nbs