Merge pull request #1057 from seeM/fix-1032

set `output-file` using notebook filename instead of `default_exp`

Author: jph00

nbdev/_modidx.py

@@ -58,6 +58,7 @@
                                 'nbdev.doclinks._get_exps': ('api/doclinks.html#_get_exps', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._get_modidx': ('api/doclinks.html#_get_modidx', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._lineno': ('api/doclinks.html#_lineno', 'nbdev/doclinks.py'),
+                                'nbdev.doclinks._nbpath2html': ('api/doclinks.html#_nbpath2html', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._qual_mod': ('api/doclinks.html#_qual_mod', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._qual_sym': ('api/doclinks.html#_qual_sym', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._qual_syms': ('api/doclinks.html#_qual_syms', 'nbdev/doclinks.py'),
@@ -76,8 +77,6 @@
                               'nbdev.export.nb_export': ('api/export.html#nb_export', 'nbdev/export.py')},
             'nbdev.extract_attachments': {},
             'nbdev.frontmatter': { 'nbdev.frontmatter.FrontmatterProc': ('api/frontmatter.html#frontmatterproc', 'nbdev/frontmatter.py'),
-                                   'nbdev.frontmatter.FrontmatterProc._default_exp_': ( 'api/frontmatter.html#frontmatterproc._default_exp_',
-                                                                                        'nbdev/frontmatter.py'),
                                    'nbdev.frontmatter.FrontmatterProc._update': ( 'api/frontmatter.html#frontmatterproc._update',
                                                                                   'nbdev/frontmatter.py'),
                                    'nbdev.frontmatter.FrontmatterProc.begin': ( 'api/frontmatter.html#frontmatterproc.begin',

nbdev/doclinks.py

@@ -43,6 +43,9 @@ def patch_name(o):
     return _sym_nm(a,o)
 
 # %% ../nbs/api/doclinks.ipynb 9
+def _nbpath2html(p): return p.with_name(re.sub(r'\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')
+
+# %% ../nbs/api/doclinks.ipynb 11
 def _get_modidx(pyfile, code_root, nbs_path):
     "Get module symbol index for a Python source file"
     cfg = get_config()
@@ -56,9 +59,8 @@ def _get_modidx(pyfile, code_root, nbs_path):
         top,*rest = cell.splitlines() # First line is cell header
         nb = top.split()[0]
         if nb != 'auto':
-            nbpath = ((pyfile.parent)/nb).resolve()  # NB paths are stored relative to .py file
-            nbpath = nbpath.with_name(re.sub(r'\d+[a-zA-Z0-9]*_', '', nbpath.name.lower()))
-            loc = nbpath.relative_to(nbs_path).with_suffix('.html')
+            nbpath = (pyfile.parent/nb).resolve()  # NB paths are stored relative to .py file
+            loc = _nbpath2html(nbpath.relative_to(nbs_path))
 
             def _stor(nm):
                 for n in L(nm): d[f'{mod_name}.{n}'] = f'{loc.as_posix()}#{n.lower()}',rel_name
@@ -69,7 +71,7 @@ def _stor(nm):
                         if isinstance(t2, _def_types): _stor(f'{tree.name}.{t2.name}')
     return {mod_name: d}
 
-# %% ../nbs/api/doclinks.ipynb 10
+# %% ../nbs/api/doclinks.ipynb 12
 def _build_modidx(dest=None, nbs_path=None, skip_exists=False):
     "Create _modidx.py"
     if dest is None: dest = get_config().lib_path
@@ -87,7 +89,7 @@ def _build_modidx(dest=None, nbs_path=None, skip_exists=False):
         res['syms'].update(_get_modidx((dest.parent/file).resolve(), code_root, nbs_path=nbs_path))
     idxfile.write_text("# Autogenerated by nbdev\n\nd = "+pformat(res, width=140, indent=2, compact=True))
 
-# %% ../nbs/api/doclinks.ipynb 15
+# %% ../nbs/api/doclinks.ipynb 17
 @delegates(globtastic)
 def nbglob(path=None, skip_folder_re = '^[_.]', file_glob='*.ipynb', skip_file_re='^[_.]', key='nbs_path', as_path=False, **kwargs):
     "Find all files in a directory matching an extension given a config key."
@@ -97,7 +99,7 @@ def nbglob(path=None, skip_folder_re = '^[_.]', file_glob='*.ipynb', skip_file_r
                      skip_file_re=skip_file_re, recursive=recursive, **kwargs)
     return res.map(Path) if as_path else res
 
-# %% ../nbs/api/doclinks.ipynb 16
+# %% ../nbs/api/doclinks.ipynb 18
 def nbglob_cli(
     path:str=None, # Path to notebooks
     symlinks:bool=False, # Follow symlinks?
@@ -111,7 +113,7 @@ def nbglob_cli(
     return nbglob(path, symlinks=symlinks, file_glob=file_glob, file_re=file_re, folder_re=folder_re,
                   skip_file_glob=skip_file_glob, skip_file_re=skip_file_re, skip_folder_re=skip_folder_re)
 
-# %% ../nbs/api/doclinks.ipynb 17
+# %% ../nbs/api/doclinks.ipynb 19
 @call_parse
 @delegates(nbglob_cli)
 def nbdev_export(
@@ -124,11 +126,11 @@ def nbdev_export(
     add_init(get_config().lib_path)
     _build_modidx()
 
-# %% ../nbs/api/doclinks.ipynb 19
+# %% ../nbs/api/doclinks.ipynb 21
 import importlib,ast
 from functools import lru_cache
 
-# %% ../nbs/api/doclinks.ipynb 20
+# %% ../nbs/api/doclinks.ipynb 22
 def _find_mod(mod):
     mp,_,mr = mod.partition('/')
     spec = importlib.util.find_spec(mp)
@@ -151,7 +153,7 @@ def _get_exps(mod):
 
 def _lineno(sym, fname): return _get_exps(fname).get(sym, None) if fname else None
 
-# %% ../nbs/api/doclinks.ipynb 22
+# %% ../nbs/api/doclinks.ipynb 24
 def _qual_sym(s, settings):
     if not isinstance(s,tuple): return s
     nb,py = s
@@ -166,10 +168,10 @@ def _qual_syms(entries):
     if 'doc_host' not in settings: return entries
     return {'syms': {mod:_qual_mod(d, settings) for mod,d in entries['syms'].items()}, 'settings':settings}
 
-# %% ../nbs/api/doclinks.ipynb 23
+# %% ../nbs/api/doclinks.ipynb 25
 _re_backticks = re.compile(r'`([^`\s]+)`')
 
-# %% ../nbs/api/doclinks.ipynb 24
+# %% ../nbs/api/doclinks.ipynb 26
 @lru_cache(None)
 class NbdevLookup:
     "Mapping from symbol names to docs and source URLs"

nbdev/frontmatter.py

@@ -6,6 +6,7 @@
 # %% ../nbs/api/frontmatter.ipynb 2
 from .imports import *
 from .process import *
+from .doclinks import _nbpath2html
 
 from execnb.nbio import *
 from fastcore.imports import *
@@ -46,8 +47,6 @@ def _insertfm(nb, fm): nb.cells.insert(0, mk_cell(_dict2fm(fm), 'raw'))
 class FrontmatterProc(Processor):
     "A YAML and formatted-markdown frontmatter processor"
     def begin(self): self.fm = getattr(self.nb, 'frontmatter_', {})
-                
-    def _default_exp_(self, cell, exp): self.default_exp = exp
 
     def _update(self, f, cell):
         s = cell.get('source')
@@ -64,6 +63,5 @@ def cell(self, cell):
     def end(self):
         self.nb.frontmatter_ = self.fm
         if not self.fm: return
-        exp = getattr(self, 'default_exp', None)
-        if exp: self.fm.update({'output-file': exp+'.html'})
+        self.fm.update({'output-file': _nbpath2html(Path(self.nb.path_)).name})
         _insertfm(self.nb, self.fm)

nbs/api/doclinks.ipynb

@@ -124,6 +124,26 @@
     "test_eq(_test_patch(s), ['_T._f', '_U._f', '_V._f'])"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "def _nbpath2html(p): return p.with_name(re.sub(r'\\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|hide\n",
+    "test_eq(_nbpath2html(Path('foo/bar/012abc_my.notebook.ipynb')), Path('foo/bar/my.notebook.html'))"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -144,9 +164,8 @@
     "        top,*rest = cell.splitlines() # First line is cell header\n",
     "        nb = top.split()[0]\n",
     "        if nb != 'auto':\n",
-    "            nbpath = ((pyfile.parent)/nb).resolve()  # NB paths are stored relative to .py file\n",
-    "            nbpath = nbpath.with_name(re.sub(r'\\d+[a-zA-Z0-9]*_', '', nbpath.name.lower()))\n",
-    "            loc = nbpath.relative_to(nbs_path).with_suffix('.html')\n",
+    "            nbpath = (pyfile.parent/nb).resolve()  # NB paths are stored relative to .py file\n",
+    "            loc = _nbpath2html(nbpath.relative_to(nbs_path))\n",
     "\n",
     "            def _stor(nm):\n",
     "                for n in L(nm): d[f'{mod_name}.{n}'] = f'{loc.as_posix()}#{n.lower()}',rel_name\n",

nbs/api/frontmatter.ipynb

@@ -31,6 +31,7 @@
     "#|export\n",
     "from nbdev.imports import *\n",
     "from nbdev.process import *\n",
+    "from nbdev.doclinks import _nbpath2html\n",
     "\n",
     "from execnb.nbio import *\n",
     "from fastcore.imports import *\n",
@@ -109,8 +110,6 @@
     "class FrontmatterProc(Processor):\n",
     "    \"A YAML and formatted-markdown frontmatter processor\"\n",
     "    def begin(self): self.fm = getattr(self.nb, 'frontmatter_', {})\n",
-    "                \n",
-    "    def _default_exp_(self, cell, exp): self.default_exp = exp\n",
     "\n",
     "    def _update(self, f, cell):\n",
     "        s = cell.get('source')\n",
@@ -127,8 +126,7 @@
     "    def end(self):\n",
     "        self.nb.frontmatter_ = self.fm\n",
     "        if not self.fm: return\n",
-    "        exp = getattr(self, 'default_exp', None)\n",
-    "        if exp: self.fm.update({'output-file': exp+'.html'})\n",
+    "        self.fm.update({'output-file': _nbpath2html(Path(self.nb.path_)).name})\n",
     "        _insertfm(self.nb, self.fm)"
    ]
   },
@@ -183,7 +181,7 @@
       "  echo: false\n",
       "key1: value1\n",
       "key2: value2\n",
-      "output-file: foobar.html\n",
+      "output-file: docs_test.html\n",
       "title: a title\n",
       "\n",
       "---\n",
@@ -221,7 +219,7 @@
        " 'key1': 'value1',\n",
        " 'key2': 'value2',\n",
        " 'categories': ['c1', 'c2'],\n",
-       " 'output-file': 'foobar.html'}"
+       " 'output-file': 'docs_test.html'}"
       ]
      },
      "execution_count": null,
@@ -244,7 +242,7 @@
     "#|hide\n",
     "test_eq(d['description'], 'A description')\n",
     "test_eq(d['categories'], ['c1','c2'])\n",
-    "test_eq(d['output-file'], 'foobar.html')"
+    "test_eq(d['output-file'], 'docs_test.html')"
    ]
   },
   {

nbs/api/migrate.ipynb

@@ -305,6 +305,7 @@
       "  and provides utilities that enhance productivity.\n",
       "draft: 'true'\n",
       "image: fastcore_imgs/td.png\n",
+      "output-file: 2020-09-01-fastcore.html\n",
       "permalink: /fastcore/\n",
       "search: 'false'\n",
       "title: 'fastcore: An Underrated Python Library'\n",
@@ -343,6 +344,7 @@
     "  and provides utilities that enhance productivity.\n",
     "draft: 'true'\n",
     "image: fastcore_imgs/td.png\n",
+    "output-file: 2020-09-01-fastcore.html\n",
     "permalink: /fastcore/\n",
     "search: 'false'\n",
     "title: 'fastcore: An Underrated Python Library'\n",
@@ -361,6 +363,7 @@
     "- jupyter\n",
     "description: A tutorial of fastpages for Jupyter notebooks.\n",
     "image: images/chart-preview.png\n",
+    "output-file: 2020-02-20-test.html\n",
     "title: Fastpages Notebook Blog Post\n",
     "toc: true\n",
     "\n",