Merge pull request #1376 from deven367/master

fixes #1364

Author: jph00

nbdev/quarto.py

@@ -251,6 +251,7 @@ def _save_cached_readme(cache, cfg):
 def nbdev_readme(
     path:str=None, # Path to notebooks
     chk_time:bool=False): # Only build if out of date
+    "Create README.md from readme_nb (index.ipynb by default)"
     cfg = get_config()
     path = Path(path) if path else cfg.nbs_path
     if chk_time and _readme_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return

nbs/api/14_quarto.ipynb

@@ -476,6 +476,7 @@
     "def nbdev_readme(\n",
     "    path:str=None, # Path to notebooks\n",
     "    chk_time:bool=False): # Only build if out of date\n",
+    "    \"Create README.md from readme_nb (index.ipynb by default)\"\n",
     "    cfg = get_config()\n",
     "    path = Path(path) if path else cfg.nbs_path\n",
     "    if chk_time and _readme_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return\n",