nbdev 2.3.25__py3-none-any.whl → 2.4.8__py3-none-any.whl

nbdev/release.py

@@ -1,29 +1,32 @@
+"""Auto-generated tagged releases and release notes from GitHub issues"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/18_release.ipynb.
 
 # %% auto 0
-__all__ = ['GH_HOST', 'Release', 'changelog', 'release_git', 'release_gh', 'pypi_json', 'latest_pypi', 'pypi_details',
-           'conda_output_path', 'write_conda_meta', 'write_requirements', 'anaconda_upload', 'release_conda',
-           'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version', 'nbdev_bump_version']
+__all__ = ['GH_HOST', 'CONDA_WARNING', 'Release', 'changelog', 'release_git', 'release_gh', 'pypi_json', 'latest_pypi',
+           'pypi_details', 'conda_output_path', 'write_conda_meta', 'write_requirements', 'anaconda_upload',
+           'release_conda', 'chk_conda_rel', 'release_pypi', 'release_both', 'bump_version', 'nbdev_bump_version']
 
-# %% ../nbs/api/18_release.ipynb 14
+# %% ../nbs/api/18_release.ipynb
 from fastcore.all import *
 from ghapi.core import *
 
 from datetime import datetime
+from packaging.version import Version
 import shutil,subprocess
 
 from .doclinks import *
 
-# %% ../nbs/api/18_release.ipynb 16
+# %% ../nbs/api/18_release.ipynb
 GH_HOST = "https://api.github.com"
 
-# %% ../nbs/api/18_release.ipynb 17
+# %% ../nbs/api/18_release.ipynb
 def _find_config(cfg_name="settings.ini"):
     cfg_path = Path().absolute()
     while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
     return Config(cfg_path, cfg_name)
 
-# %% ../nbs/api/18_release.ipynb 18
+# %% ../nbs/api/18_release.ipynb
 def _issue_txt(issue):
     res = '- {} ([#{}]({}))'.format(issue.title.strip(), issue.number, issue.html_url)
     if hasattr(issue, 'pull_request'): res += ', thanks to [@{}]({})'.format(issue.user.login, issue.user.html_url)
@@ -40,7 +43,7 @@ def _load_json(cfg, k):
     try: return json.loads(cfg[k])
     except json.JSONDecodeError as e: raise Exception(f"Key: `{k}` in .ini file is not a valid JSON string: {e}")
 
-# %% ../nbs/api/18_release.ipynb 20
+# %% ../nbs/api/18_release.ipynb
 class Release:
     def __init__(self, owner=None, repo=None, token=None, **groups):
         "Create CHANGELOG.md from GitHub issues"
@@ -60,17 +63,20 @@ class Release:
 
     def _issues(self, label):
         return self.gh.issues.list_for_repo(state='closed', sort='created', filter='all', since=self.commit_date, labels=label)
-    def _issue_groups(self): return parallel(self._issues, self.groups.keys(), progress=False)
+    def _issue_groups(self): return parallel(self._issues, self.groups.keys(), progress=False, threadpool=True)
 
-# %% ../nbs/api/18_release.ipynb 22
+# %% ../nbs/api/18_release.ipynb
 @patch
 def changelog(self:Release,
               debug=False): # Just print the latest changes, instead of updating file
     "Create the CHANGELOG.md file, or return the proposed text if `debug` is `True`"
     if not self.changefile.exists(): self.changefile.write_text("# Release notes\n\n<!-- do not remove -->\n")
     marker = '<!-- do not remove -->\n'
-    try: self.commit_date = self.gh.repos.get_latest_release().published_at
-    except HTTP404NotFoundError: self.commit_date = '2000-01-01T00:00:004Z'
+    try: self.commit_date = (lr:=self.gh.repos.get_latest_release()).published_at
+    except HTTP404NotFoundError: lr,self.commit_date = None,'2000-01-01T00:00:004Z'
+    if lr and (Version(self.cfg.version) <= Version(lr.tag_name)): 
+        print(f'Error: Version bump required: expected: >{lr.tag_name}, got: {self.cfg.version}.')
+        raise SystemExit(1)
     res = f"\n## {self.cfg.version}\n"
     issues = self._issue_groups()
     res += '\n'.join(_issues_txt(*o) for o in zip(issues, self.groups.values()))
@@ -80,7 +86,7 @@ def changelog(self:Release,
     self.changefile.write_text(res)
     run(f'git add {self.changefile}')
 
-# %% ../nbs/api/18_release.ipynb 24
+# %% ../nbs/api/18_release.ipynb
 @patch
 def release(self:Release):
     "Tag and create a release in GitHub for the current version"
@@ -89,7 +95,7 @@ def release(self:Release):
     self.gh.create_release(ver, branch=self.cfg.branch, body=notes)
     return ver
 
-# %% ../nbs/api/18_release.ipynb 26
+# %% ../nbs/api/18_release.ipynb
 @patch
 def latest_notes(self:Release):
     "Latest CHANGELOG entry"
@@ -98,7 +104,7 @@ def latest_notes(self:Release):
     if not len(its)>0: return ''
     return '\n'.join(its[1].splitlines()[1:]).strip()
 
-# %% ../nbs/api/18_release.ipynb 29
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def changelog(
     debug:store_true=False,  # Print info to be added to CHANGELOG, instead of updating file
@@ -108,7 +114,7 @@ def changelog(
     res = Release(repo=repo).changelog(debug=debug)
     if debug: print(res)
 
-# %% ../nbs/api/18_release.ipynb 30
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def release_git(
     token:str=None  # Optional GitHub token (otherwise `token` file is used)
@@ -117,7 +123,7 @@ def release_git(
     ver = Release(token=token).release()
     print(f"Released {ver}")
 
-# %% ../nbs/api/18_release.ipynb 31
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def release_gh(
     token:str=None  # Optional GitHub token (otherwise `token` file is used)
@@ -132,7 +138,7 @@ def release_gh(
     ver = Release(token=token).release()
     print(f"Released {ver}")
 
-# %% ../nbs/api/18_release.ipynb 33
+# %% ../nbs/api/18_release.ipynb
 from fastcore.all import *
 from .config import *
 from .cli import *
@@ -144,18 +150,18 @@ except ImportError: from pip._vendor.packaging.version import parse
 
 _PYPI_URL = 'https://pypi.org/pypi/'
 
-# %% ../nbs/api/18_release.ipynb 34
+# %% ../nbs/api/18_release.ipynb
 def pypi_json(s):
     "Dictionary decoded JSON for PYPI path `s`"
     return urljson(f'{_PYPI_URL}{s}/json')
 
-# %% ../nbs/api/18_release.ipynb 35
+# %% ../nbs/api/18_release.ipynb
 def latest_pypi(name):
     "Latest version of `name` on pypi"
     return max(parse(r) for r,o in pypi_json(name)['releases'].items()
                if not parse(r).is_prerelease and not nested_idx(o, 0, 'yanked'))
 
-# %% ../nbs/api/18_release.ipynb 36
+# %% ../nbs/api/18_release.ipynb
 def pypi_details(name):
     "Version, URL, and SHA256 for `name` from pypi"
     ver = str(latest_pypi(name))
@@ -163,7 +169,7 @@ def pypi_details(name):
     rel = [o for o in pypi['urls'] if o['packagetype']=='sdist'][0]
     return ver,rel['url'],rel['digests']['sha256']
 
-# %% ../nbs/api/18_release.ipynb 37
+# %% ../nbs/api/18_release.ipynb
 import shlex
 from subprocess import Popen, PIPE, CalledProcessError
 
@@ -177,12 +183,12 @@ def _run(cmd):
     if p.returncode != 0: raise CalledProcessError(p.returncode, p.args)
     return res
 
-# %% ../nbs/api/18_release.ipynb 38
+# %% ../nbs/api/18_release.ipynb
 def conda_output_path(name, build='build'):
     "Output path for conda build"
     return run(f'conda {build} --output {name}').strip().replace('\\', '/')
 
-# %% ../nbs/api/18_release.ipynb 39
+# %% ../nbs/api/18_release.ipynb
 def _write_yaml(path, name, d1, d2):
     path = Path(path)
     p = path/name
@@ -192,7 +198,7 @@ def _write_yaml(path, name, d1, d2):
         yaml.safe_dump(d1, f)
         yaml.safe_dump(d2, f)
 
-# %% ../nbs/api/18_release.ipynb 40
+# %% ../nbs/api/18_release.ipynb
 def _get_conda_meta():
     cfg = get_config()
     name,ver = cfg.lib_name,cfg.version
@@ -234,12 +240,12 @@ def _get_conda_meta():
     }
     return name,d1,d2
 
-# %% ../nbs/api/18_release.ipynb 41
+# %% ../nbs/api/18_release.ipynb
 def write_conda_meta(path='conda'):
     "Writes a `meta.yaml` file to the `conda` directory of the current directory"
     _write_yaml(path, *_get_conda_meta())
 
-# %% ../nbs/api/18_release.ipynb 43
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def write_requirements(path:str=''):
     "Writes a `requirements.txt` file to `directory` based on settings.ini."
@@ -248,9 +254,12 @@ def write_requirements(path:str=''):
     req = '\n'.join([cfg.get(k, '').replace(' ', '\n') for k in ['requirements', 'pip_requirements']])
     (d/'requirements.txt').mk_write(req)
 
-# %% ../nbs/api/18_release.ipynb 45
+# %% ../nbs/api/18_release.ipynb
+CONDA_WARNING='Conda support for nbdev is deprecated and scheduled for removal in a future version.'
+
 def anaconda_upload(name, loc=None, user=None, token=None, env_token=None):
     "Upload `name` to anaconda"
+    warn(CONDA_WARNING)
     user = f'-u {user} ' if user else ''
     if env_token: token = os.getenv(env_token)
     token = f'-t {token} ' if token else ''
@@ -258,7 +267,7 @@ def anaconda_upload(name, loc=None, user=None, token=None, env_token=None):
     if not loc: raise Exception("Failed to find output")
     return _run(f'anaconda {token} upload {user} {loc} --skip-existing')
 
-# %% ../nbs/api/18_release.ipynb 47
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def release_conda(
     path:str='conda', # Path where package will be created
@@ -269,6 +278,7 @@ def release_conda(
     upload_user:str=None  # Optional user to upload package to
 ):
     "Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it"
+    warn(CONDA_WARNING)
     name = get_config().lib_name
     write_conda_meta(path)
     out = f"Done. Next steps:\n```\ncd {path}\n"""
@@ -286,10 +296,10 @@ def release_conda(
     if skip_upload: return print(loc)
     if not upload_user: upload_user = get_config().conda_user
     if not upload_user: return print("`conda_user` not in settings.ini and no `upload_user` passed. Cannot upload")
-    if 'anaconda upload' not in res: return print(f"{res}\n\Failed. Check auto-upload not set in .condarc. Try `--do_build False`.")
+    if 'anaconda upload' not in res: return print(f"{res}\n\nFailed. Check auto-upload not set in .condarc. Try `--do_build False`.")
     return anaconda_upload(name, loc)
 
-# %% ../nbs/api/18_release.ipynb 48
+# %% ../nbs/api/18_release.ipynb
 def chk_conda_rel(
     nm:str,  # Package name on pypi
     apkg:str=None,  # Anaconda Package (defaults to {nm})
@@ -303,17 +313,17 @@ def chk_conda_rel(
     pypitag = latest_pypi(nm)
     if force or not condatag or pypitag > max(condatag): return f'{pypitag}'
 
-# %% ../nbs/api/18_release.ipynb 50
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def release_pypi(
     repository:str="pypi" # Respository to upload to (defined in ~/.pypirc)
 ):
     "Create and upload Python package to PyPI"
     _dir = get_config().lib_path.parent
-    system(f'cd {_dir}  && rm -rf dist build && python setup.py sdist bdist_wheel')
+    system(f'cd {_dir}  && rm -rf dist build && python -m build')
     system(f'twine upload --repository {repository} {_dir}/dist/*')
 
-# %% ../nbs/api/18_release.ipynb 52
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def release_both(
     path:str='conda', # Path where package will be created
@@ -329,7 +339,7 @@ def release_both(
     release_conda.__wrapped__(path, do_build=do_build, build_args=build_args, skip_upload=skip_upload, mambabuild=mambabuild, upload_user=upload_user)
     nbdev_bump_version.__wrapped__()
 
-# %% ../nbs/api/18_release.ipynb 54
+# %% ../nbs/api/18_release.ipynb
 def bump_version(version, part=2, unbump=False):
     version = version.split('.')
     incr = -1 if unbump else 1
@@ -337,7 +347,7 @@ def bump_version(version, part=2, unbump=False):
     for i in range(part+1, 3): version[i] = '0'
     return '.'.join(version)
 
-# %% ../nbs/api/18_release.ipynb 55
+# %% ../nbs/api/18_release.ipynb
 @call_parse
 def nbdev_bump_version(
     part:int=2,  # Part of version to bump

nbdev/serve.py

@@ -1,9 +1,11 @@
+"""A parallel ipynb processor (experimental)"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/17_serve.ipynb.
 
 # %% auto 0
 __all__ = ['proc_nbs']
 
-# %% ../nbs/api/17_serve.ipynb 2
+# %% ../nbs/api/17_serve.ipynb
 import ast,subprocess,threading,sys
 from shutil import rmtree,copy2
 
@@ -17,7 +19,7 @@ from .doclinks import nbglob_cli,nbglob
 from .processors import FilterDefaults
 import nbdev.serve_drv
 
-# %% ../nbs/api/17_serve.ipynb 4
+# %% ../nbs/api/17_serve.ipynb
 def _is_qpy(path:Path):
     "Is `path` a py script starting with frontmatter?"
     path = Path(path)
@@ -32,9 +34,9 @@ def _is_qpy(path:Path):
         vl = v.splitlines()
         if vl[0]=='---' and vl[-1]=='---': return '\n'.join(vl[1:-1])
 
-# %% ../nbs/api/17_serve.ipynb 5
+# %% ../nbs/api/17_serve.ipynb
 def _proc_file(s, cache, path, mtime=None):
-    skips = ('_proc', '_docs', '_site')
+    skips = ('_proc', '_docs', '_site', 'settings.ini')
     if not s.is_file() or any(o[0]=='.' or o in skips for o in s.parts): return
     d = cache/s.relative_to(path)
     if s.suffix=='.py': d = d.with_suffix('')
@@ -49,7 +51,7 @@ def _proc_file(s, cache, path, mtime=None):
     if md is not None: return s,d,md.strip()
     else: copy2(s,d)
 
-# %% ../nbs/api/17_serve.ipynb 7
+# %% ../nbs/api/17_serve.ipynb
 @delegates(nbglob_cli)
 def proc_nbs(
     path:str='', # Path to notebooks
@@ -64,6 +66,7 @@ def proc_nbs(
     path = Path(path or cfg.nbs_path)
     files = nbglob(path, func=Path, file_glob='', file_re='', **kwargs)
     if (path/'_quarto.yml').exists(): files.append(path/'_quarto.yml')
+    if (path/'_brand.yml').exists(): files.append(path/'_brand.yml')
     if (path/'_extensions').exists(): files.extend(nbglob(path/'_extensions', func=Path, file_glob='', file_re='', skip_file_re='^[.]'))
 
     # If settings.ini or filter script newer than cache folder modified, delete cache

nbdev/showdoc.py

@@ -1,3 +1,5 @@
+"""Display symbol documentation in notebook and website"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/08_showdoc.ipynb.
 
 # %% ../nbs/api/08_showdoc.ipynb 2
@@ -5,7 +7,6 @@ from __future__ import annotations
 from .doclinks import *
 from .config import get_config
 
-from fastcore.dispatch import TypeDispatch
 from fastcore.docments import *
 from fastcore.utils import *
 
@@ -16,152 +17,12 @@ from textwrap import fill
 from types import FunctionType
 
 # %% auto 0
-__all__ = ['DocmentTbl', 'ShowDocRenderer', 'BasicMarkdownRenderer', 'show_doc', 'BasicHtmlRenderer', 'doc', 'showdoc_nm',
-           'colab_link']
-
-# %% ../nbs/api/08_showdoc.ipynb 6
-def _non_empty_keys(d:dict): return L([k for k,v in d.items() if v != inspect._empty])
-def _bold(s): return f'**{s}**' if s.strip() else s
-
-# %% ../nbs/api/08_showdoc.ipynb 7
-def _escape_markdown(s):
-    for c in '|^': s = re.sub(rf'\\?\{c}', f'\{c}', s)
-    return s.replace('\n', '<br>')
-
-# %% ../nbs/api/08_showdoc.ipynb 9
-def _maybe_nm(o):
-    if (o == inspect._empty): return ''
-    else: return o.__name__ if hasattr(o, '__name__') else _escape_markdown(str(o))
-
-# %% ../nbs/api/08_showdoc.ipynb 11
-def _list2row(l:list): return '| '+' | '.join([_maybe_nm(o) for o in l]) + ' |'
-
-# %% ../nbs/api/08_showdoc.ipynb 13
-class DocmentTbl:
-    # this is the column order we want these items to appear
-    _map = OrderedDict({'anno':'Type', 'default':'Default', 'docment':'Details'})
-
-    def __init__(self, obj, verbose=True, returns=True):
-        "Compute the docment table string"
-        self.verbose = verbose
-        self.returns = False if isdataclass(obj) else returns
-        try: self.params = L(signature_ex(obj, eval_str=True).parameters.keys())
-        except (ValueError,TypeError): self.params=[]
-        try: _dm = docments(obj, full=True, returns=returns)
-        except: _dm = {}
-        if 'self' in _dm: del _dm['self']
-        for d in _dm.values(): d['docment'] = ifnone(d['docment'], inspect._empty)
-        self.dm = _dm
-
-    @property
-    def _columns(self):
-        "Compute the set of fields that have at least one non-empty value so we don't show tables empty columns"
-        cols = set(flatten(L(self.dm.values()).filter().map(_non_empty_keys)))
-        candidates = self._map if self.verbose else {'docment': 'Details'}
-        return OrderedDict({k:v for k,v in candidates.items() if k in cols})
-
-    @property
-    def has_docment(self): return 'docment' in self._columns and self._row_list
-
-    @property
-    def has_return(self): return self.returns and bool(_non_empty_keys(self.dm.get('return', {})))
-
-    def _row(self, nm, props):
-        "unpack data for single row to correspond with column names."
-        return [nm] + [props[c] for c in self._columns]
-
-    @property
-    def _row_list(self):
-        "unpack data for all rows."
-        ordered_params = [(p, self.dm[p]) for p in self.params if p != 'self' and p in self.dm]
-        return L([self._row(nm, props) for nm,props in ordered_params])
-
-    @property
-    def _hdr_list(self): return ['  '] + [_bold(l) for l in L(self._columns.values())]
-
-    @property
-    def hdr_str(self):
-        "The markdown string for the header portion of the table"
-        md = _list2row(self._hdr_list)
-        return md + '\n' + _list2row(['-' * len(l) for l in self._hdr_list])
-
-    @property
-    def params_str(self):
-        "The markdown string for the parameters portion of the table."
-        return '\n'.join(self._row_list.map(_list2row))
-
-    @property
-    def return_str(self):
-        "The markdown string for the returns portion of the table."
-        return _list2row(['**Returns**']+[_bold(_maybe_nm(self.dm['return'][c])) for c in self._columns])
+__all__ = ['BasicMarkdownRenderer', 'show_doc', 'BasicHtmlRenderer', 'doc', 'showdoc_nm', 'colab_link']
 
-    def _repr_markdown_(self):
-        if not self.has_docment: return ''
-        _tbl = [self.hdr_str, self.params_str]
-        if self.has_return: _tbl.append(self.return_str)
-        return '\n'.join(_tbl)
-
-    def __eq__(self,other): return self.__str__() == str(other).strip()
-
-    __str__ = _repr_markdown_
-    __repr__ = basic_repr()
-
-# %% ../nbs/api/08_showdoc.ipynb 28
-def _docstring(sym):
-    npdoc = parse_docstring(sym)
-    return '\n\n'.join([npdoc['Summary'], npdoc['Extended']]).strip()
-
-# %% ../nbs/api/08_showdoc.ipynb 29
-def _fullname(o):
-    module,name = getattr(o, "__module__", None),qual_name(o)
-    return name if module is None or module in ('__main__','builtins') else module + '.' + name
-
-class ShowDocRenderer:
-    def __init__(self, sym, name:str|None=None, title_level:int=3):
-        "Show documentation for `sym`"
-        sym = getattr(sym, '__wrapped__', sym)
-        sym = getattr(sym, 'fget', None) or getattr(sym, 'fset', None) or sym
-        store_attr()
-        self.nm = name or qual_name(sym)
-        self.isfunc = inspect.isfunction(sym)
-        try: self.sig = signature_ex(sym, eval_str=True)
-        except (ValueError,TypeError): self.sig = None
-        self.docs = _docstring(sym)
-        self.dm = DocmentTbl(sym)
-        self.fn = _fullname(sym)
-
-    __repr__ = basic_repr()
-
-# %% ../nbs/api/08_showdoc.ipynb 30
-def _f_name(o): return f'<function {o.__name__}>' if isinstance(o, FunctionType) else None
-def _fmt_anno(o): return inspect.formatannotation(o).strip("'").replace(' ','')
-
-def _show_param(param):
-    "Like `Parameter.__str__` except removes: quotes in annos, spaces, ids in reprs"
-    kind,res,anno,default = param.kind,param._name,param._annotation,param._default
-    kind = '*' if kind==inspect._VAR_POSITIONAL else '**' if kind==inspect._VAR_KEYWORD else ''
-    res = kind+res
-    if anno is not inspect._empty: res += f':{_f_name(anno) or _fmt_anno(anno)}'
-    if default is not inspect._empty: res += f'={_f_name(default) or repr(default)}'
-    return res
-
-# %% ../nbs/api/08_showdoc.ipynb 32
-def _fmt_sig(sig):
-    if sig is None: return ''
-    p = {k:v for k,v in sig.parameters.items()}
-    _params = [_show_param(p[k]) for k in p.keys() if k != 'self']
-    return "(" + ', '.join(_params)  + ")"
-
-def _wrap_sig(s):
-    "wrap a signature to appear on multiple lines if necessary."
-    pad = '> ' + ' ' * 5
-    indent = pad + ' ' * (s.find('(') + 1)
-    return fill(s, width=80, initial_indent=pad, subsequent_indent=indent)
-
-# %% ../nbs/api/08_showdoc.ipynb 34
+# %% ../nbs/api/08_showdoc.ipynb
 def _ext_link(url, txt, xtra=""): return f'[{txt}]({url}){{target="_blank" {xtra}}}'
 
-class BasicMarkdownRenderer(ShowDocRenderer):
+class BasicMarkdownRenderer(MarkdownRenderer):
     "Markdown renderer for `show_doc`"
     def _repr_markdown_(self):
         doc = '---\n\n'
@@ -169,14 +30,9 @@ class BasicMarkdownRenderer(ShowDocRenderer):
         if src: doc += _ext_link(src, 'source', 'style="float:right; font-size:smaller"') + '\n\n'
         h = '#'*self.title_level
         doc += f'{h} {self.nm}\n\n'
-        sig = _wrap_sig(f"{self.nm} {_fmt_sig(self.sig)}") if self.sig else ''
-        doc += f'{sig}'
-        if self.docs: doc += f"\n\n*{self.docs}*"
-        if self.dm.has_docment: doc += f"\n\n{self.dm}"
-        return doc
-    __repr__=__str__=_repr_markdown_
+        return doc+super()._repr_markdown_()
 
-# %% ../nbs/api/08_showdoc.ipynb 35
+# %% ../nbs/api/08_showdoc.ipynb
 def show_doc(sym,  # Symbol to document
              renderer=None,  # Optional renderer (defaults to markdown)
              name:str|None=None,  # Optionally override displayed name of `sym`
@@ -187,44 +43,71 @@ def show_doc(sym,  # Symbol to document
     elif isinstance(renderer,str):
         p,m = renderer.rsplit('.', 1)
         renderer = getattr(import_module(p), m)
-    if isinstance(sym, TypeDispatch): pass
+    if isinstance_str(sym, "Function"): pass
+    elif isinstance_str(sym, "TypeDispatch"): pass  # use _str as TypeDispatch will be removed from fastcore
     else:return renderer(sym or show_doc, name=name, title_level=title_level)
 
-# %% ../nbs/api/08_showdoc.ipynb 51
+# %% ../nbs/api/08_showdoc.ipynb
+def _create_html_table(table_str):
+    def split_row(row):
+        return re.findall(r'\|(?:(?:\\.|[^|\\])*)', row)
+    
+    def unescape_cell(cell): 
+        return cell.strip(' *|').replace(r'\|', '|')
+    
+    lines = table_str.strip().split('\n')
+    header = [f"<th>{unescape_cell(cell)}</th>" for cell in split_row(lines[0])]
+    rows = [[f"<td>{unescape_cell(cell)}</td>" for cell in split_row(line)] for line in lines[2:]]
+    
+    return f'''<table>
+    <thead><tr>{' '.join(header)}</tr></thead>
+    <tbody>{''.join(f'<tr>{" ".join(row)}</tr>' for row in rows)}</tbody>
+    </table>'''
+
+# %% ../nbs/api/08_showdoc.ipynb
 def _html_link(url, txt): return f'<a href="{url}" target="_blank" rel="noreferrer noopener">{txt}</a>'
 
+# %% ../nbs/api/08_showdoc.ipynb
+from fastcore.docments import _fmt_sig
+
+# %% ../nbs/api/08_showdoc.ipynb
 class BasicHtmlRenderer(ShowDocRenderer):
-    "Simple HTML renderer for `show_doc`"
+    "HTML renderer for `show_doc`"
     def _repr_html_(self):
         doc = '<hr/>\n'
+        src = NbdevLookup().code(self.fn)
         doc += f'<h{self.title_level}>{self.nm}</h{self.title_level}>\n'
-        doc += f'<blockquote><pre><code>{self.nm}{_fmt_sig(self.sig)}</code></pre></blockquote>'
-        if self.docs: doc += f"<p><i>{self.docs}</i></p>"
+        sig = _fmt_sig(self.sig) if self.sig else ''
+        # Escape < and > characters in the signature
+        sig = sig.replace('<', '&lt;').replace('>', '&gt;')
+        doc += f'<blockquote><pre><code>{self.nm} {sig}</code></pre></blockquote>'
+        if self.docs:
+            doc += f"<p><i>{self.docs}</i></p>"
+        if src: doc += f"<br/>{_html_link(src, 'source')}"
+        if self.dm.has_docment: doc += _create_html_table(str(self.dm))
         return doc
 
     def doc(self):
         "Show `show_doc` info along with link to docs"
         from IPython.display import display,HTML
         res = self._repr_html_()
-        docs = NbdevLookup().doc(self.fn)
-        if docs is not None: res += '\n<p>' +_html_link(docs, "Show in docs") + '</p>'
         display(HTML(res))
 
-# %% ../nbs/api/08_showdoc.ipynb 52
+# %% ../nbs/api/08_showdoc.ipynb
 def doc(elt):
     "Show `show_doc` info along with link to docs"
     BasicHtmlRenderer(elt).doc()
 
-# %% ../nbs/api/08_showdoc.ipynb 58
+# %% ../nbs/api/08_showdoc.ipynb
 def showdoc_nm(tree):
     "Get the fully qualified name for showdoc."
     return ifnone(patch_name(tree), tree.name)
 
-# %% ../nbs/api/08_showdoc.ipynb 62
+# %% ../nbs/api/08_showdoc.ipynb
 def colab_link(path):
     "Get a link to the notebook at `path` on Colab"
     from IPython.display import Markdown
     cfg = get_config()
     pre = 'https://colab.research.google.com/github/'
-    res = f'{pre}{cfg.user}/{cfg.lib_name}/blob/{cfg.branch}/{cfg.nbs_path.name}/{path}.ipynb'
+    res = f'{pre}{cfg.user}/{cfg.repo}/blob/{cfg.branch}/{cfg.nbs_path.name}/{path}.ipynb'
     display(Markdown(f'[Open `{path}` in Colab]({res})'))

nbdev/sync.py

@@ -1,9 +1,11 @@
+"""Propagate small changes in the library back to notebooks"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/06_sync.ipynb.
 
 # %% auto 0
 __all__ = ['absolute_import', 'nbdev_update']
 
-# %% ../nbs/api/06_sync.ipynb 3
+# %% ../nbs/api/06_sync.ipynb
 from .imports import *
 from .config import *
 from .maker import *
@@ -17,9 +19,9 @@ from fastcore.script import *
 from fastcore.xtras import *
 
 import ast
-from importlib import import_module
+import importlib
 
-# %% ../nbs/api/06_sync.ipynb 5
+# %% ../nbs/api/06_sync.ipynb
 def absolute_import(name, fname, level):
     "Unwarps a relative import in `name` according to `fname`"
     if not level: return name
@@ -27,22 +29,25 @@ def absolute_import(name, fname, level):
     if not name: return '.'.join(mods)
     return '.'.join(mods[:len(mods)-level+1]) + f".{name}"
 
-# %% ../nbs/api/06_sync.ipynb 7
+# %% ../nbs/api/06_sync.ipynb
 @functools.lru_cache(maxsize=None)
 def _mod_files():
-    midx = import_module(f'{get_config().lib_path.name}._modidx')
+    midx_spec = importlib.util.spec_from_file_location("_modidx", get_config().lib_path / "_modidx.py")
+    midx = importlib.util.module_from_spec(midx_spec)
+    midx_spec.loader.exec_module(midx)
+
     return L(files for mod in midx.d['syms'].values() for _,files in mod.values()).unique()
 
-# %% ../nbs/api/06_sync.ipynb 8
-_re_import = re.compile("from\s+\S+\s+import\s+\S")
+# %% ../nbs/api/06_sync.ipynb
+_re_import = re.compile(r"from\s+\S+\s+import\s+\S")
 
-# %% ../nbs/api/06_sync.ipynb 10
+# %% ../nbs/api/06_sync.ipynb
 def _to_absolute(code, py_path, lib_dir):
     if not _re_import.search(code): return code
     res = update_import(code, ast.parse(code).body, str(py_path.relative_to(lib_dir).parent), absolute_import)
     return ''.join(res) if res else code
 
-# %% ../nbs/api/06_sync.ipynb 11
+# %% ../nbs/api/06_sync.ipynb
 def _update_nb(nb_path, cells, lib_dir):
     "Update notebook `nb_path` with contents from `cells`"
     nbp = NBProcessor(nb_path, ExportModuleProc(), rm_directives=False)
@@ -54,19 +59,20 @@ def _update_nb(nb_path, cells, lib_dir):
         nbcell.source = ''.join(dirs) + _to_absolute(cell.code, cell.py_path, lib_dir)
     write_nb(nbp.nb, nb_path)
 
-# %% ../nbs/api/06_sync.ipynb 12
+# %% ../nbs/api/06_sync.ipynb
 def _update_mod(py_path, lib_dir):
     "Propagate changes from cells in module `py_path` to corresponding notebooks"
     py_cells = L(_iter_py_cells(py_path)).filter(lambda o: o.nb != 'auto')
     for nb_path,cells in groupby(py_cells, 'nb_path').items(): _update_nb(nb_path, cells, lib_dir)
 
-# %% ../nbs/api/06_sync.ipynb 14
+# %% ../nbs/api/06_sync.ipynb
 @call_parse
 def nbdev_update(fname:str=None): # A Python file name to update
     "Propagate change in modules matching `fname` to notebooks that created them"
     if fname and fname.endswith('.ipynb'): raise ValueError("`nbdev_update` operates on .py files.  If you wish to convert notebooks instead, see `nbdev_export`.")
     if os.environ.get('IN_TEST',0): return
     cfg = get_config()
+    if not cfg.cell_number: raise ValueError("`nbdev_update` does not support without cell_number in .py files. Please check your settings.ini")
     fname = Path(fname or cfg.lib_path)
     lib_dir = cfg.lib_path.parent
     files = globtastic(fname, file_glob='*.py', skip_folder_re='^[_.]').filter(lambda x: str(Path(x).absolute().relative_to(lib_dir) in _mod_files()))