fixes #1656

Author: jph00

nbdev/quarto.py

@@ -23,7 +23,7 @@
 from fastcore.meta import delegates
 from .serve import proc_nbs,_proc_file
 from . import serve_drv
-from .quarto_render import render_quarto
+from .quarto_render import render_quarto, quarto_stale
 import yaml
 
 # %% ../nbs/api/14_quarto.ipynb #aae2d2be-ad03-4536-bf70-c4575f39cea3
@@ -392,7 +392,7 @@ def nbdev_preview(
     cache,cfg,path = _pre_docs(path, n_workers=n_workers, **kwargs)
     site = cache/cfg.doc_path.name
     if not (render or site.exists()) and cfg.doc_path.exists(): copytree(cfg.doc_path, site)
-    if render or not site.exists(): render_quarto(cache, site, n_workers=n_workers)
+    if render or not site.exists() or quarto_stale(cache, site): render_quarto(cache, site, n_workers=n_workers)
     xtra = []
     if port: xtra += ['--port', str(port)]
     if host: xtra += ['--host', host]

nbdev/quarto_render.py

@@ -1,10 +1,9 @@
 "Parallel Quarto website rendering in isolated project copies."
 
 import json, shutil, subprocess, tempfile
-from pathlib import Path
 from xml.etree import ElementTree as ET
 from fastcore.parallel import parallel
-from fastcore.utils import defaults
+from fastcore.utils import *
 
 
 def _quarto(path, *args):
@@ -13,6 +12,17 @@ def _quarto(path, *args):
     return res.stdout
 
 
+def quarto_stale(path, output_dir):
+    "Whether a page's HTML output is missing or older than its processed source."
+    path, output_dir = Path(path).resolve(), Path(output_dir).resolve()
+    info = loads(_quarto(path, 'inspect'))
+    for name,entry in info['fileInformation'].items():
+        p = Path(name)
+        output = output_dir/p.parent/(entry['metadata'].get('output-file') or p.with_suffix('.html').name)
+        if not output.exists() or (path/p).stat().st_mtime>output.stat().st_mtime: return True
+    return False
+
+
 def _render_batch(job):
     path, inputs, output = job
     _quarto(path, 'render', *inputs, '--no-cache', '--no-clean', '--output-dir', output)

nbs/api/14_quarto.ipynb

@@ -50,7 +50,7 @@
     "from fastcore.meta import delegates\n",
     "from nbdev.serve import proc_nbs,_proc_file\n",
     "from nbdev import serve_drv\n",
-    "from nbdev.quarto_render import render_quarto\n",
+    "from nbdev.quarto_render import render_quarto, quarto_stale\n",
     "import yaml"
    ]
   },
@@ -737,7 +737,7 @@
    "source": [
     "## Preview\n",
     "\n",
-    "`nbdev-preview` keeps its own copy of the site in the `_proc` cache, rendering new or changed pages on startup and as you edit; it doesn't change `doc_path`. When the cache has no site it starts from a copy of the one in `doc_path`, so unchanged pages from the last `nbdev-docs` run aren't rendered again. With neither, it builds all pages in parallel using the same `--n-workers` setting as `nbdev-docs`. Use `nbdev-preview --render` to rebuild everything, including changes to shared configuration or filters."
+    "`nbdev-preview` keeps its own copy of the site in the `_proc` cache, rendering new or changed pages on startup and as you edit; it doesn't change `doc_path`. When the cache has no site it starts from a copy of the one in `doc_path`, so unchanged pages from the last `nbdev-docs` run aren't rendered again. If any processed page has missing or older HTML output, it rebuilds the site in parallel using the same `--n-workers` setting as `nbdev-docs`, then starts Quarto's usual preview and input watching. Use `nbdev-preview --render` to rebuild everything, including changes to shared configuration or filters."
    ]
   },
   {
@@ -787,7 +787,7 @@
     "    cache,cfg,path = _pre_docs(path, n_workers=n_workers, **kwargs)\n",
     "    site = cache/cfg.doc_path.name\n",
     "    if not (render or site.exists()) and cfg.doc_path.exists(): copytree(cfg.doc_path, site)\n",
-    "    if render or not site.exists(): render_quarto(cache, site, n_workers=n_workers)\n",
+    "    if render or not site.exists() or quarto_stale(cache, site): render_quarto(cache, site, n_workers=n_workers)\n",
     "    xtra = []\n",
     "    if port: xtra += ['--port', str(port)]\n",
     "    if host: xtra += ['--host', host]\n",

tests/test_quarto_render.py

@@ -1,7 +1,7 @@
 import json, shutil, subprocess, pytest
 from xml.etree import ElementTree as ET
 from fastcore.test import test_eq as teq
-from nbdev.quarto_render import render_quarto
+from nbdev.quarto_render import render_quarto, quarto_stale
 from nbdev.quarto import nbdev_readme, refresh_quarto_yml
 from nbdev.readme_filter import doc_link
 from fastcore.nbio import new_nb, mk_cell, write_nb
@@ -65,14 +65,17 @@ def test_website(tmp_path):
 Page {name}. [Alpha](alpha.qmd#detail). [Download](data.txt).
 ''')
     (root/'data.txt').write_text('shared resource')
-    serial, parallel = tmp_path/'serial', tmp_path/'parallel'
+    (root/'other.qmd').write_text('---\noutput-file: renamed.html\n---\n# Other')
+    serial, parallel = tmp_path/'serial', root/'_site'
+    assert quarto_stale(root, parallel)
     render_quarto(root, serial, n_workers=1)
     render_quarto(root, parallel, n_workers=2)
+    assert not quarto_stale(root, parallel)
     search = lambda d: {e['href']: e['text'] for e in json.loads((d/'search.json').read_text())}
     urls = lambda d: {e.text for e in ET.parse(d/'sitemap.xml').findall('.//{*}loc')}
     teq(search(serial), search(parallel))
     teq(urls(serial), urls(parallel))
-    teq(len(urls(parallel)), 3)
+    teq(len(urls(parallel)), 4)
     for name in ('index', 'alpha', 'beta'):
         html = (parallel/f'{name}.html').read_text()
         assert 'alpha.html#detail' in html and 'data.txt' in html
@@ -81,7 +84,9 @@ def test_website(tmp_path):
     assert (parallel/'site_libs').is_dir()
     assert 'http-equiv="refresh"' not in (parallel/'index.html').read_text()
     (root/'beta.qmd').write_text('---\ntitle: beta\n---\n## Detail\n\nUpdated beta.')
+    assert quarto_stale(root, parallel)
     subprocess.run(['quarto', 'render', 'beta.qmd', '--quiet', '--output-dir', str(parallel)], cwd=root, check=True)
+    assert not quarto_stale(root, parallel)
     teq(set(search(serial)), set(search(parallel)))
     assert 'Updated beta.' in search(parallel)['beta.html#detail']
     (root/'beta.qmd').write_text('---\nfilters: [missing.lua]\n---\nBroken.')