update style

Author: bclavie

nbdev/quarto.py

@@ -275,48 +275,29 @@ def _save_cached_contributing(cache, cfg, contrib_nb):
     contrib_file = tmp_doc_path / 'CONTRIBUTING.md'
     if contrib_file.exists():
         final_path = cfg.config_path / 'CONTRIBUTING.md'
-        if final_path.exists(): final_path.unlink()  # Py3.7 doesn't have missing_ok
+        if final_path.exists(): final_path.unlink() # py37 doesn't have `missing_ok`
         move(contrib_file, final_path)
-        # Move any supporting files folder
-        assets_folder = tmp_doc_path / (Path(contrib_nb).stem + '_files')
-        if assets_folder.exists():
-            _copytree(assets_folder, cfg.config_path / assets_folder.name)
+        assets_folder = tmp_doc_path / (Path(contrib_nb).stem + '_files') # Supporting files for CONTRIBUTING
+        if assets_folder.exists(): _copytree(assets_folder, cfg.config_path / assets_folder.name)
 
 # %% ../nbs/api/14_quarto.ipynb
 @call_parse
 def nbdev_contributing(
-    path:str=None,  # Path to notebooks (defaults to nbs_path)
+    path:str=None,  # Path to notebooks
     chk_time:bool=False  # Only build if out-of-date
 ):
-    """
-    Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present).
-    Skips if the file doesn't exist.
-    """
+    """Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist."""
     cfg = get_config()
     path = Path(path) if path else cfg.nbs_path
-    
-    # Decide which notebook is your "contributing" NB (you can hardcode or add to settings.ini)
     contrib_nb_name = cfg.get('contributing_nb', 'contributing.ipynb')
     contrib_nb_path = path / contrib_nb_name
+    if not contrib_nb_path.exists(): return
+    if chk_time and _doc_mtime_not_older(cfg.config_path / 'CONTRIBUTING.md' , contrib_nb_path): return
 
-    contrib_md = cfg.config_path / 'CONTRIBUTING.md'
-    
-    # If out of date check is requested, skip if up-to-date or missing
-    if chk_time and _doc_mtime_not_older(contrib_md, contrib_nb_path):
-        return
-    
-    # If there's no contributing notebook, do nothing
-    if not contrib_nb_path.exists():
-        return
-    
-    # Temporarily remove sidebar.yml so Quarto doesn't try to build the entire site
-    with _SidebarYmlRemoved(path):
+    with _SidebarYmlRemoved(path): # to avoid rendering whole website
         cache = proc_nbs(path)
-        
-        # Render a single .ipynb -> .md in GFM
         _sprun(f'cd "{cache}" && quarto render "{cache/contrib_nb_name}" -o CONTRIBUTING.md -t gfm --no-execute')
 
-    # Copy the newly created CONTRIBUTING.md and _files folder back to the repo root
     _save_cached_contributing(cache, cfg, contrib_nb_name)
 
 

nbs/api/14_quarto.ipynb

@@ -524,12 +524,10 @@
     "    contrib_file = tmp_doc_path / 'CONTRIBUTING.md'\n",
     "    if contrib_file.exists():\n",
     "        final_path = cfg.config_path / 'CONTRIBUTING.md'\n",
-    "        if final_path.exists(): final_path.unlink()  # Py3.7 doesn't have missing_ok\n",
+    "        if final_path.exists(): final_path.unlink() # py37 doesn't have `missing_ok`\n",
     "        move(contrib_file, final_path)\n",
-    "        # Move any supporting files folder\n",
-    "        assets_folder = tmp_doc_path / (Path(contrib_nb).stem + '_files')\n",
-    "        if assets_folder.exists():\n",
-    "            _copytree(assets_folder, cfg.config_path / assets_folder.name)"
+    "        assets_folder = tmp_doc_path / (Path(contrib_nb).stem + '_files') # Supporting files for CONTRIBUTING\n",
+    "        if assets_folder.exists(): _copytree(assets_folder, cfg.config_path / assets_folder.name)"
    ]
   },
   {
@@ -542,38 +540,21 @@
     "#|export\n",
     "@call_parse\n",
     "def nbdev_contributing(\n",
-    "    path:str=None,  # Path to notebooks (defaults to nbs_path)\n",
+    "    path:str=None,  # Path to notebooks\n",
     "    chk_time:bool=False  # Only build if out-of-date\n",
     "):\n",
-    "    \"\"\"\n",
-    "    Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present).\n",
-    "    Skips if the file doesn't exist.\n",
-    "    \"\"\"\n",
+    "    \"\"\"Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.\"\"\"\n",
     "    cfg = get_config()\n",
     "    path = Path(path) if path else cfg.nbs_path\n",
-    "    \n",
-    "    # Decide which notebook is your \"contributing\" NB (you can hardcode or add to settings.ini)\n",
     "    contrib_nb_name = cfg.get('contributing_nb', 'contributing.ipynb')\n",
     "    contrib_nb_path = path / contrib_nb_name\n",
+    "    if not contrib_nb_path.exists(): return\n",
+    "    if chk_time and _doc_mtime_not_older(cfg.config_path / 'CONTRIBUTING.md' , contrib_nb_path): return\n",
     "    \n",
-    "    contrib_md = cfg.config_path / 'CONTRIBUTING.md'\n",
-    "    \n",
-    "    # If out of date check is requested, skip if up-to-date or missing\n",
-    "    if chk_time and _doc_mtime_not_older(contrib_md, contrib_nb_path):\n",
-    "        return\n",
-    "    \n",
-    "    # If there's no contributing notebook, do nothing\n",
-    "    if not contrib_nb_path.exists():\n",
-    "        return\n",
-    "    \n",
-    "    # Temporarily remove sidebar.yml so Quarto doesn't try to build the entire site\n",
-    "    with _SidebarYmlRemoved(path):\n",
+    "    with _SidebarYmlRemoved(path): # to avoid rendering whole website\n",
     "        cache = proc_nbs(path)\n",
-    "        \n",
-    "        # Render a single .ipynb -> .md in GFM\n",
     "        _sprun(f'cd \"{cache}\" && quarto render \"{cache/contrib_nb_name}\" -o CONTRIBUTING.md -t gfm --no-execute')\n",
     "        \n",
-    "    # Copy the newly created CONTRIBUTING.md and _files folder back to the repo root\n",
     "    _save_cached_contributing(cache, cfg, contrib_nb_name)\n"
    ]
   },