fixes #1059

Author: jph00

nbdev/config.py

@@ -64,7 +64,6 @@ def _apply_defaults(
     jupyter_hooks=True, # Run Jupyter hooks?
     clean_ids=True, # Remove ids from plaintext reprs?
     clear_all=False, # Remove all cell metadata and cell outputs?
-    custom_quarto_yml=False, # Use a custom _quarto.yml?
     put_version_in_init=True, # Add the version to the main __init__.py in nbdev_export
 ):
     "Apply default settings where missing in `cfg`."
@@ -144,8 +143,8 @@ def _cfg2txt(cfg, head, sections, tail=''):
 
 '''
 _nbdev_cfg_sections = {'Python library': 'repo lib_name version min_python license',
-                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags',
-                       'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title custom_quarto_yml',
+                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init',
+                       'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title',
                        'PyPI': 'audience author author_email copyright description keywords language status user'}
 _nbdev_cfg_tail = '''### Optional ###
 # requirements = fastcore pandas

nbdev/quarto.py

@@ -128,53 +128,50 @@ def _ensure_quarto():
 # %% ../nbs/api/quarto.ipynb 14
 _quarto_yml="""project:
   type: website
-  output-dir: {doc_path}
-  preview:
-    port: 3000
-    browser: false
 
 format:
   html:
     theme: cosmo
     css: styles.css
     toc: true
-    toc-depth: 4
 
 website:
-  title: "{title}"
-  site-url: "{doc_host}{doc_baseurl}"
-  description: "{description}"
   twitter-card: true
   open-graph: true
-  repo-branch: {branch}
-  repo-url: "{git_url}"
   repo-actions: [issue]
   navbar:
     background: primary
     search: true
-    right:
-      - icon: github
-        href: "{git_url}"
   sidebar:
-    style: "floating"
+    style: floating
 
-metadata-files: 
-  - sidebar.yml
-  - custom.yml
-"""
+metadata-files: [nbdev.yml, sidebar.yml]"""
 
 # %% ../nbs/api/quarto.ipynb 15
+_nbdev_yml="""project:
+  output-dir: {doc_path}
+
+website:
+  title: "{title}"
+  site-url: "{doc_host}{doc_baseurl}"
+  description: "{description}"
+  repo-branch: {branch}
+  repo-url: "{git_url}"
+"""
+
+# %% ../nbs/api/quarto.ipynb 16
 def refresh_quarto_yml():
     "Generate `_quarto.yml` from `settings.ini`."
     cfg = get_config()
-    if cfg.get('custom_quarto_yml', False): return
-    p = cfg.nbs_path/'_quarto.yml'
+    ny = cfg.nbs_path/'nbdev.yml'
     vals = {k:cfg[k] for k in ['title', 'description', 'branch', 'git_url', 'doc_host', 'doc_baseurl']}
     vals['doc_path'] = cfg.doc_path.name
     if 'title' not in vals: vals['title'] = vals['lib_name']
-    p.write_text(_quarto_yml.format(**vals))
+    ny.write_text(_nbdev_yml.format(**vals))
+    qy = cfg.nbs_path/'_quarto.yml'
+    if not qy.exists(): qy.write_text(_quarto_yml)
 
-# %% ../nbs/api/quarto.ipynb 16
+# %% ../nbs/api/quarto.ipynb 17
 @call_parse
 def nbdev_readme(
     path:str=None, # Path to notebooks
@@ -208,7 +205,7 @@ def nbdev_readme(
         move(readme, cfg_path)
         if _rdmi.exists(): copytree(_rdmi, cfg_path/_rdmi.name) # Move Supporting files for README
 
-# %% ../nbs/api/quarto.ipynb 18
+# %% ../nbs/api/quarto.ipynb 19
 @call_parse
 @delegates(_nbglob_docs)
 def nbdev_docs(
@@ -222,7 +219,7 @@ def nbdev_docs(
     shutil.rmtree(cfg.doc_path, ignore_errors=True)
     move(cache/cfg.doc_path.name, cfg.config_path)
 
-# %% ../nbs/api/quarto.ipynb 20
+# %% ../nbs/api/quarto.ipynb 21
 @call_parse
 @delegates(nbdev_docs)
 def deploy(
@@ -235,7 +232,7 @@ def deploy(
     except: return warnings.warn('Please install ghp-import with `pip install ghp-import`')
     ghp_import(get_config().doc_path, push=True, stderr=True, no_history=True)
 
-# %% ../nbs/api/quarto.ipynb 21
+# %% ../nbs/api/quarto.ipynb 22
 @call_parse
 def prepare():
     "Export, test, and clean notebooks, and render README if needed"
@@ -246,7 +243,7 @@ def prepare():
     refresh_quarto_yml()
     nbdev_readme.__wrapped__(chk_time=True)
 
-# %% ../nbs/api/quarto.ipynb 23
+# %% ../nbs/api/quarto.ipynb 24
 @contextmanager
 def fs_watchdog(func, path, recursive:bool=True):
     "File system watchdog dispatching to `func`"
@@ -262,7 +259,7 @@ class _ProcessHandler(FileSystemEventHandler): dispatch=func
         observer.stop()
         observer.join()
 
-# %% ../nbs/api/quarto.ipynb 24
+# %% ../nbs/api/quarto.ipynb 25
 @call_parse
 @delegates(_nbglob_docs)
 def nbdev_preview(

nbs/api/config.ipynb

@@ -172,7 +172,6 @@
     "    jupyter_hooks=True, # Run Jupyter hooks?\n",
     "    clean_ids=True, # Remove ids from plaintext reprs?\n",
     "    clear_all=False, # Remove all cell metadata and cell outputs?\n",
-    "    custom_quarto_yml=False, # Use a custom _quarto.yml?\n",
     "    put_version_in_init=True, # Add the version to the main __init__.py in nbdev_export\n",
     "):\n",
     "    \"Apply default settings where missing in `cfg`.\"\n",
@@ -346,8 +345,8 @@
     "\n",
     "'''\n",
     "_nbdev_cfg_sections = {'Python library': 'repo lib_name version min_python license',\n",
-    "                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags',\n",
-    "                       'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title custom_quarto_yml',\n",
+    "                       'nbdev': 'doc_path lib_path nbs_path recursive tst_flags put_version_in_init',\n",
+    "                       'Docs': 'branch custom_sidebar doc_host doc_baseurl git_url title',\n",
     "                       'PyPI': 'audience author author_email copyright description keywords language status user'}\n",
     "_nbdev_cfg_tail = '''### Optional ###\n",
     "# requirements = fastcore pandas\n",

nbs/api/quarto.ipynb

@@ -253,39 +253,43 @@
     "#|export\n",
     "_quarto_yml=\"\"\"project:\n",
     "  type: website\n",
-    "  output-dir: {doc_path}\n",
-    "  preview:\n",
-    "    port: 3000\n",
-    "    browser: false\n",
     "\n",
     "format:\n",
     "  html:\n",
     "    theme: cosmo\n",
     "    css: styles.css\n",
     "    toc: true\n",
-    "    toc-depth: 4\n",
     "\n",
     "website:\n",
-    "  title: \"{title}\"\n",
-    "  site-url: \"{doc_host}{doc_baseurl}\"\n",
-    "  description: \"{description}\"\n",
     "  twitter-card: true\n",
     "  open-graph: true\n",
-    "  repo-branch: {branch}\n",
-    "  repo-url: \"{git_url}\"\n",
     "  repo-actions: [issue]\n",
     "  navbar:\n",
     "    background: primary\n",
     "    search: true\n",
-    "    right:\n",
-    "      - icon: github\n",
-    "        href: \"{git_url}\"\n",
     "  sidebar:\n",
-    "    style: \"floating\"\n",
+    "    style: floating\n",
     "\n",
-    "metadata-files: \n",
-    "  - sidebar.yml\n",
-    "  - custom.yml\n",
+    "metadata-files: [nbdev.yml, sidebar.yml]\"\"\""
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "id": "faabf6e6",
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "_nbdev_yml=\"\"\"project:\n",
+    "  output-dir: {doc_path}\n",
+    "\n",
+    "website:\n",
+    "  title: \"{title}\"\n",
+    "  site-url: \"{doc_host}{doc_baseurl}\"\n",
+    "  description: \"{description}\"\n",
+    "  repo-branch: {branch}\n",
+    "  repo-url: \"{git_url}\"\n",
     "\"\"\""
    ]
   },
@@ -300,12 +304,13 @@
     "def refresh_quarto_yml():\n",
     "    \"Generate `_quarto.yml` from `settings.ini`.\"\n",
     "    cfg = get_config()\n",
-    "    if cfg.get('custom_quarto_yml', False): return\n",
-    "    p = cfg.nbs_path/'_quarto.yml'\n",
+    "    ny = cfg.nbs_path/'nbdev.yml'\n",
     "    vals = {k:cfg[k] for k in ['title', 'description', 'branch', 'git_url', 'doc_host', 'doc_baseurl']}\n",
     "    vals['doc_path'] = cfg.doc_path.name\n",
     "    if 'title' not in vals: vals['title'] = vals['lib_name']\n",
-    "    p.write_text(_quarto_yml.format(**vals))"
+    "    ny.write_text(_nbdev_yml.format(**vals))\n",
+    "    qy = cfg.nbs_path/'_quarto.yml'\n",
+    "    if not qy.exists(): qy.write_text(_quarto_yml)"
    ]
   },
   {