nbdev 2.3.27__tar.gz → 2.3.28__tar.gz

{nbdev-2.3.27/nbdev.egg-info → nbdev-2.3.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: nbdev
-Version: 2.3.27
+Version: 2.3.28
 Summary: Create delightful software with Jupyter Notebooks
 Home-page: https://github.com/fastai/nbdev
 Author: Jeremy Howard and Hamel Husain
@@ -15,7 +15,8 @@ Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.3.27"
+__version__ = "2.3.28"
 
 from .doclinks import nbdev_export
 from .showdoc import show_doc

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/_modidx.py

@@ -71,6 +71,7 @@ d = { 'settings': { 'branch': 'master',
                                 'nbdev.doclinks.nbglob_cli': ('api/doclinks.html#nbglob_cli', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks.patch_name': ('api/doclinks.html#patch_name', 'nbdev/doclinks.py')},
             'nbdev.export': { 'nbdev.export.ExportModuleProc': ('api/export.html#exportmoduleproc', 'nbdev/export.py'),
+                              'nbdev.export.ExportModuleProc.__call__': ('api/export.html#exportmoduleproc.__call__', 'nbdev/export.py'),
                               'nbdev.export.ExportModuleProc._default_exp_': ( 'api/export.html#exportmoduleproc._default_exp_',
                                                                                'nbdev/export.py'),
                               'nbdev.export.ExportModuleProc._export_': ('api/export.html#exportmoduleproc._export_', 'nbdev/export.py'),

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/clean.py

@@ -1,9 +1,11 @@
+"""Strip superfluous metadata from notebooks"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/11_clean.ipynb.
 
 # %% auto 0
 __all__ = ['nbdev_trust', 'clean_nb', 'process_write', 'nbdev_clean', 'clean_jupyter', 'nbdev_install_hooks']
 
-# %% ../nbs/api/11_clean.ipynb 2
+# %% ../nbs/api/11_clean.ipynb
 import ast,warnings,stat
 from astunparse import unparse
 from textwrap import indent
@@ -18,7 +20,7 @@ from .config import *
 from .sync import *
 from .process import first_code_ln
 
-# %% ../nbs/api/11_clean.ipynb 6
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_trust(
     fname:str=None,  # A notebook name or glob to trust
@@ -45,7 +47,7 @@ def nbdev_trust(
         if not NotebookNotary().check_signature(nb): NotebookNotary().sign(nb)
     check_fname.touch(exist_ok=True)
 
-# %% ../nbs/api/11_clean.ipynb 9
+# %% ../nbs/api/11_clean.ipynb
 _repr_id_re = re.compile('(<.*?)( at 0x[0-9a-fA-F]+)(>)')
 
 _sub = partial(_repr_id_re.sub, r'\1\3')
@@ -55,7 +57,7 @@ def _skip_or_sub(x): return _sub(x) if "at 0x" in x else x
 def _clean_cell_output_id(lines):
     return _skip_or_sub(lines) if isinstance(lines,str) else [_skip_or_sub(o) for o in lines]
 
-# %% ../nbs/api/11_clean.ipynb 11
+# %% ../nbs/api/11_clean.ipynb
 def _clean_cell_output(cell, clean_ids):
     "Remove `cell` output execution count and optionally ids from text reprs"
     outputs = cell.get('outputs', [])
@@ -69,7 +71,7 @@ def _clean_cell_output(cell, clean_ids):
         if 'text' in o and clean_ids: o['text'] = _clean_cell_output_id(o['text'])
         o.get('metadata', {}).pop('tags', None)
 
-# %% ../nbs/api/11_clean.ipynb 12
+# %% ../nbs/api/11_clean.ipynb
 def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     "Clean `cell` by removing superfluous metadata or everything except the input if `clear_all`"
     if 'execution_count' in cell: cell['execution_count'] = None
@@ -80,7 +82,7 @@ def _clean_cell(cell, clear_all, allowed_metadata_keys, clean_ids):
     cell['metadata'] = {} if clear_all else {
         k:v for k,v in cell['metadata'].items() if k in allowed_metadata_keys}
 
-# %% ../nbs/api/11_clean.ipynb 13
+# %% ../nbs/api/11_clean.ipynb
 def clean_nb(
     nb, # The notebook to clean
     clear_all=False, # Remove all cell metadata and cell outputs?
@@ -98,12 +100,12 @@ def clean_nb(
         nb['metadata']['kernelspec']['display_name'] = nb["metadata"]["kernelspec"]["name"]
     nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}
 
-# %% ../nbs/api/11_clean.ipynb 26
+# %% ../nbs/api/11_clean.ipynb
 def _reconfigure(*strms):
     for s in strms:
         if hasattr(s,'reconfigure'): s.reconfigure(encoding='utf-8')
 
-# %% ../nbs/api/11_clean.ipynb 27
+# %% ../nbs/api/11_clean.ipynb
 def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
     if not f_out: f_out = f_in
     if isinstance(f_in, (str,Path)): f_in = Path(f_in).open(encoding="utf-8")
@@ -116,7 +118,7 @@ def process_write(warn_msg, proc_nb, f_in, f_out=None, disp=False):
         warn(f'{warn_msg}')
         warn(e)
 
-# %% ../nbs/api/11_clean.ipynb 28
+# %% ../nbs/api/11_clean.ipynb
 def _nbdev_clean(nb, path=None, clear_all=None):
     cfg = get_config(path=path)
     clear_all = clear_all or cfg.clear_all
@@ -125,7 +127,7 @@ def _nbdev_clean(nb, path=None, clear_all=None):
     clean_nb(nb, clear_all, allowed_metadata_keys, allowed_cell_metadata_keys, cfg.clean_ids)
     if path: nbdev_trust.__wrapped__(path)
 
-# %% ../nbs/api/11_clean.ipynb 29
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_clean(
     fname:str=None, # A notebook name or glob to clean
@@ -141,7 +143,7 @@ def nbdev_clean(
     if fname is None: fname = get_config().nbs_path
     for f in globtastic(fname, file_glob='*.ipynb', skip_folder_re='^[_.]'): _write(f_in=f, disp=disp)
 
-# %% ../nbs/api/11_clean.ipynb 32
+# %% ../nbs/api/11_clean.ipynb
 def clean_jupyter(path, model, **kwargs):
     "Clean Jupyter `model` pre save to `path`"
     if not (model['type']=='notebook' and model['content']['nbformat']==4): return
@@ -149,7 +151,7 @@ def clean_jupyter(path, model, **kwargs):
     jupyter_hooks = get_config(path=path).jupyter_hooks
     if jupyter_hooks: _nbdev_clean(model['content'], path=path)
 
-# %% ../nbs/api/11_clean.ipynb 35
+# %% ../nbs/api/11_clean.ipynb
 _pre_save_hook_src = '''
 def nbdev_clean_jupyter(**kwargs):
     try: from nbdev.clean import clean_jupyter
@@ -159,7 +161,7 @@ def nbdev_clean_jupyter(**kwargs):
 c.ContentsManager.pre_save_hook = nbdev_clean_jupyter'''.strip()
 _pre_save_hook_re = re.compile(r'c\.(File)?ContentsManager\.pre_save_hook')
 
-# %% ../nbs/api/11_clean.ipynb 36
+# %% ../nbs/api/11_clean.ipynb
 def _add_jupyter_hooks(src, path):
     if _pre_save_hook_src in src: return
     mod = ast.parse(src)
@@ -177,12 +179,12 @@ def _add_jupyter_hooks(src, path):
     if src: src+='\n\n'
     return src+_pre_save_hook_src
 
-# %% ../nbs/api/11_clean.ipynb 40
+# %% ../nbs/api/11_clean.ipynb
 def _git_root(): 
     try: return Path(run('git rev-parse --show-toplevel'))
     except OSError: return None
 
-# %% ../nbs/api/11_clean.ipynb 43
+# %% ../nbs/api/11_clean.ipynb
 @call_parse
 def nbdev_install_hooks():
     "Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks"

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/cli.py

@@ -1,3 +1,5 @@
+"""CLI commands"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/13_cli.ipynb.
 
 # %% ../nbs/api/13_cli.ipynb 2
@@ -27,7 +29,7 @@ import os, tarfile, sys
 # %% auto 0
 __all__ = ['mapping', 'nbdev_filter', 'extract_tgz', 'nbdev_new', 'nbdev_update_license', 'chelp']
 
-# %% ../nbs/api/13_cli.ipynb 5
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def nbdev_filter(
     nb_txt:str=None,  # Notebook text (uses stdin if not provided)
@@ -50,12 +52,12 @@ def nbdev_filter(
     if printit: print(res, flush=True)
     else: return res
 
-# %% ../nbs/api/13_cli.ipynb 8
+# %% ../nbs/api/13_cli.ipynb
 def extract_tgz(url, dest='.'):
     from fastcore.net import urlopen
     with urlopen(url) as u: tarfile.open(mode='r:gz', fileobj=u).extractall(dest)
 
-# %% ../nbs/api/13_cli.ipynb 9
+# %% ../nbs/api/13_cli.ipynb
 def _render_nb(fn, cfg):
     "Render templated values like `{{lib_name}}` in notebook at `fn` from `cfg`"
     txt = fn.read_text()
@@ -63,7 +65,7 @@ def _render_nb(fn, cfg):
     for k,v in cfg.d.items(): txt = txt.replace('{{'+k+'}}', v)
     fn.write_text(txt)
 
-# %% ../nbs/api/13_cli.ipynb 10
+# %% ../nbs/api/13_cli.ipynb
 def _update_repo_meta(cfg):
     "Enable gh pages and update the homepage and description in your GitHub repo."
     token=os.getenv('GITHUB_TOKEN')
@@ -74,7 +76,7 @@ def _update_repo_meta(cfg):
         except HTTPError:print(f"Could not update the description & URL on the repo: {cfg.user}/{cfg.repo} using $GITHUB_TOKEN.\n"
                   "Use a token with the correction permissions or perform these steps manually.")
 
-# %% ../nbs/api/13_cli.ipynb 11
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 @delegates(nbdev_create_config)
 def nbdev_new(**kwargs):
@@ -123,7 +125,7 @@ def nbdev_new(**kwargs):
     nbdev_export.__wrapped__()
     nbdev_readme.__wrapped__()
 
-# %% ../nbs/api/13_cli.ipynb 13
+# %% ../nbs/api/13_cli.ipynb
 mapping = {
   'mit': 'mit',
   'apache2': 'apache-2.0',
@@ -132,7 +134,7 @@ mapping = {
   'bsd3': 'bsd-3-clause'
 }
 
-# %% ../nbs/api/13_cli.ipynb 14
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def nbdev_update_license(
     to: str=None, # update license to
@@ -163,7 +165,7 @@ def nbdev_update_license(
     lic.write(body)
     print(f"License updated from {curr_lic} to {to}")
 
-# %% ../nbs/api/13_cli.ipynb 17
+# %% ../nbs/api/13_cli.ipynb
 @call_parse
 def chelp():
     "Show help for all console scripts"

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/config.py

@@ -1,5 +1,4 @@
-"""Read and write nbdev's `settings.ini` file.
-`get_config` is the main function for reading settings."""
+"""Configuring nbdev and bootstrapping notebook export"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/01_config.ipynb.
 
@@ -7,11 +6,7 @@
 __all__ = ['nbdev_create_config', 'get_config', 'config_key', 'create_output', 'show_src', 'update_version', 'add_init',
            'write_cells']
 
-# %% ../nbs/api/01_config.ipynb 2
-_doc_ = """Read and write nbdev's `settings.ini` file.
-`get_config` is the main function for reading settings."""
-
-# %% ../nbs/api/01_config.ipynb 3
+# %% ../nbs/api/01_config.ipynb
 from datetime import datetime
 from fastcore.docments import *
 from fastcore.utils import *
@@ -25,16 +20,16 @@ from IPython.display import Markdown
 from execnb.nbio import read_nb,NbCell
 from urllib.error import HTTPError
 
-# %% ../nbs/api/01_config.ipynb 8
+# %% ../nbs/api/01_config.ipynb
 _nbdev_home_dir = 'nbdev' # sub-directory of xdg base dir
 _nbdev_cfg_name = 'settings.ini'
 
-# %% ../nbs/api/01_config.ipynb 9
+# %% ../nbs/api/01_config.ipynb
 def _git_repo():
     try: return repo_details(run('git config --get remote.origin.url'))[1]
     except OSError: return
 
-# %% ../nbs/api/01_config.ipynb 11
+# %% ../nbs/api/01_config.ipynb
 # When adding a named default to the list below, be sure that that name
 # is also added to one of the sections in `_nbdev_cfg_sections` as well,
 # or it won't get written by `nbdev_create_config`:
@@ -82,7 +77,7 @@ def _apply_defaults(
         cfg[k] = v
     return cfg
 
-# %% ../nbs/api/01_config.ipynb 12
+# %% ../nbs/api/01_config.ipynb
 def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):
     from ghapi.all import GhApi
     api = GhApi(owner=owner, repo=repo, token=os.getenv('GITHUB_TOKEN'))
@@ -98,7 +93,7 @@ https://nbdev.fast.ai/api/release.html#setup"""]
     
     return r.default_branch, default_kw if not getattr(r, 'topics', []) else ' '.join(r.topics), r.description
 
-# %% ../nbs/api/01_config.ipynb 14
+# %% ../nbs/api/01_config.ipynb
 def _fetch_from_git(raise_err=False):
     "Get information for settings.ini from the user."
     res={}
@@ -114,7 +109,7 @@ def _fetch_from_git(raise_err=False):
     else: res['lib_name'] = res['repo'].replace('-','_')
     return res
 
-# %% ../nbs/api/01_config.ipynb 16
+# %% ../nbs/api/01_config.ipynb
 def _prompt_user(cfg, inferred):
     "Let user input values not in `cfg` or `inferred`."
     res = cfg.copy()
@@ -128,7 +123,7 @@ def _prompt_user(cfg, inferred):
                 print(msg+res[k]+' # Automatically inferred from git')
     return res
 
-# %% ../nbs/api/01_config.ipynb 18
+# %% ../nbs/api/01_config.ipynb
 def _cfg2txt(cfg, head, sections, tail=''):
     "Render `cfg` with commented sections."
     nm = cfg.d.name
@@ -140,7 +135,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
     res += tail
     return res.strip()
 
-# %% ../nbs/api/01_config.ipynb 20
+# %% ../nbs/api/01_config.ipynb
 _nbdev_cfg_head = '''# All sections below are required unless otherwise specified.
 # See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
 
@@ -157,7 +152,7 @@ _nbdev_cfg_tail = '''### Optional ###
 # package_data = 
 '''
 
-# %% ../nbs/api/01_config.ipynb 21
+# %% ../nbs/api/01_config.ipynb
 @call_parse
 @delegates(_apply_defaults, but='cfg')
 def nbdev_create_config(
@@ -183,19 +178,19 @@ def nbdev_create_config(
     cfg_fn = Path(path)/cfg_name
     print(f'{cfg_fn} created.')
 
-# %% ../nbs/api/01_config.ipynb 24
+# %% ../nbs/api/01_config.ipynb
 def _nbdev_config_file(cfg_name=_nbdev_cfg_name, path=None):
     cfg_path = path = Path.cwd() if path is None else Path(path)
     while cfg_path != cfg_path.parent and not (cfg_path/cfg_name).exists(): cfg_path = cfg_path.parent
     if not (cfg_path/cfg_name).exists(): cfg_path = path
     return cfg_path/cfg_name
 
-# %% ../nbs/api/01_config.ipynb 26
+# %% ../nbs/api/01_config.ipynb
 def _xdg_config_paths(cfg_name=_nbdev_cfg_name):
     xdg_config_paths = reversed([xdg_config_home()]+xdg_config_dirs())
     return [o/_nbdev_home_dir/cfg_name for o in xdg_config_paths]
 
-# %% ../nbs/api/01_config.ipynb 27
+# %% ../nbs/api/01_config.ipynb
 def _type(t): return bool if t==bool_arg else t
 _types = {k:_type(v['anno']) for k,v in docments(_apply_defaults,full=True,returns=False).items() if k != 'cfg'}
 
@@ -207,22 +202,22 @@ def get_config(cfg_name=_nbdev_cfg_name, path=None):
     cfg = Config(cfg_file.parent, cfg_file.name, extra_files=extra_files, types=_types)
     return _apply_defaults(cfg)
 
-# %% ../nbs/api/01_config.ipynb 42
+# %% ../nbs/api/01_config.ipynb
 def config_key(c, default=None, path=True, missing_ok=None):
     "Deprecated: use `get_config().get` or `get_config().path` instead."
     warn("`config_key` is deprecated. Use `get_config().get` or `get_config().path` instead.", DeprecationWarning)
     return get_config().path(c, default) if path else get_config().get(c, default)
 
-# %% ../nbs/api/01_config.ipynb 44
+# %% ../nbs/api/01_config.ipynb
 def create_output(txt, mime):
     "Add a cell output containing `txt` of the `mime` text MIME sub-type"
     return [{"data": { f"text/{mime}": str(txt).splitlines(True) },
              "execution_count": 1, "metadata": {}, "output_type": "execute_result"}]
 
-# %% ../nbs/api/01_config.ipynb 45
+# %% ../nbs/api/01_config.ipynb
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
-# %% ../nbs/api/01_config.ipynb 48
+# %% ../nbs/api/01_config.ipynb
 _re_version = re.compile(r'^__version__\s*=.*$', re.MULTILINE)
 _init = '__init__.py'
 
@@ -251,15 +246,15 @@ def add_init(path=None):
         if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()
     if get_config().get('put_version_in_init', True): update_version(path)
 
-# %% ../nbs/api/01_config.ipynb 51
+# %% ../nbs/api/01_config.ipynb
 def write_cells(cells, hdr, file, offset=0, cell_number=True):
     "Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use)."
     for cell in cells:
-        if cell.source.strip():
+        if cell.cell_type=='code' and cell.source.strip():
             idx = f" {cell.idx_+offset}" if cell_number else ""
             file.write(f'\n\n{hdr}{idx}\n{cell.source}')
 
-# %% ../nbs/api/01_config.ipynb 52
+# %% ../nbs/api/01_config.ipynb
 def _basic_export_nb(fname, name, dest=None):
     "Basic exporter to bootstrap nbdev."
     if dest is None: dest = get_config().lib_path

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/doclinks.py

@@ -1,9 +1,11 @@
+"""Generating a documentation index from a module"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/05_doclinks.ipynb.
 
 # %% auto 0
 __all__ = ['patch_name', 'nbglob', 'nbglob_cli', 'nbdev_export', 'NbdevLookup']
 
-# %% ../nbs/api/05_doclinks.ipynb 2
+# %% ../nbs/api/05_doclinks.ipynb
 from .config import *
 from .maker import *
 from .export import *
@@ -21,7 +23,7 @@ from pprint import pformat
 from urllib.parse import urljoin
 from functools import lru_cache
 
-# %% ../nbs/api/05_doclinks.ipynb 5
+# %% ../nbs/api/05_doclinks.ipynb
 def _sym_nm(klas, sym): return f'{unparse(klas).strip()}.{sym.name}'
 
 def _binop_leafs(bo, o):
@@ -42,7 +44,7 @@ def patch_name(o):
     else: return o.name
     return _sym_nm(a,o)
 
-# %% ../nbs/api/05_doclinks.ipynb 9
+# %% ../nbs/api/05_doclinks.ipynb
 def _iter_py_cells(p):
     "Yield cells from an exported Python file."
     p = Path(p)
@@ -64,10 +66,10 @@ def _iter_py_cells(p):
         if code.endswith('\n'): code=code[:-1]
         yield AttrDict(nb=nb, idx=idx, code=code, nb_path=nb_path, py_path=p.resolve())
 
-# %% ../nbs/api/05_doclinks.ipynb 11
+# %% ../nbs/api/05_doclinks.ipynb
 def _nbpath2html(p): return p.with_name(re.sub(r'^\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')
 
-# %% ../nbs/api/05_doclinks.ipynb 13
+# %% ../nbs/api/05_doclinks.ipynb
 def _get_modidx(py_path, code_root, nbs_path):
     "Get module symbol index for a Python source file"
     cfg = get_config()
@@ -89,7 +91,7 @@ def _get_modidx(py_path, code_root, nbs_path):
                     if isinstance(t2, _def_types): _stor(f'{tree.name}.{t2.name}')
     return {mod_name: d}
 
-# %% ../nbs/api/05_doclinks.ipynb 15
+# %% ../nbs/api/05_doclinks.ipynb
 def _build_modidx(dest=None, nbs_path=None, skip_exists=False):
     "Create _modidx.py"
     if dest is None: dest = get_config().lib_path
@@ -108,7 +110,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)+'\n')
 
-# %% ../nbs/api/05_doclinks.ipynb 20
+# %% ../nbs/api/05_doclinks.ipynb
 @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."
@@ -118,7 +120,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/05_doclinks.ipynb 21
+# %% ../nbs/api/05_doclinks.ipynb
 def nbglob_cli(
     path:str=None, # Path to notebooks
     symlinks:bool=False, # Follow symlinks?
@@ -132,7 +134,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/05_doclinks.ipynb 22
+# %% ../nbs/api/05_doclinks.ipynb
 @call_parse
 @delegates(nbglob_cli)
 def nbdev_export(
@@ -149,11 +151,11 @@ def nbdev_export(
     add_init(get_config().lib_path)
     _build_modidx()
 
-# %% ../nbs/api/05_doclinks.ipynb 25
+# %% ../nbs/api/05_doclinks.ipynb
 import importlib,ast
 from functools import lru_cache
 
-# %% ../nbs/api/05_doclinks.ipynb 26
+# %% ../nbs/api/05_doclinks.ipynb
 def _find_mod(mod):
     mp,_,mr = mod.partition('/')
     spec = importlib.util.find_spec(mp)
@@ -176,7 +178,7 @@ def _get_exps(mod):
 
 def _lineno(sym, fname): return _get_exps(fname).get(sym, None) if fname else None
 
-# %% ../nbs/api/05_doclinks.ipynb 28
+# %% ../nbs/api/05_doclinks.ipynb
 def _qual_sym(s, settings):
     if not isinstance(s,tuple): return s
     nb,py = s
@@ -191,10 +193,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/05_doclinks.ipynb 29
+# %% ../nbs/api/05_doclinks.ipynb
 _re_backticks = re.compile(r'`([^`\s]+)`')
 
-# %% ../nbs/api/05_doclinks.ipynb 30
+# %% ../nbs/api/05_doclinks.ipynb
 @lru_cache(None)
 class NbdevLookup:
     "Mapping from symbol names to docs and source URLs"

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/export.py

@@ -1,9 +1,11 @@
+"""Exporting a notebook to a library"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/04_export.ipynb.
 
 # %% auto 0
 __all__ = ['ExportModuleProc', 'black_format', 'scrub_magics', 'optional_procs', 'nb_export']
 
-# %% ../nbs/api/04_export.ipynb 2
+# %% ../nbs/api/04_export.ipynb
 from .config import *
 from .maker import *
 from .imports import *
@@ -15,7 +17,7 @@ from fastcore.imports import *
 
 from collections import defaultdict
 
-# %% ../nbs/api/04_export.ipynb 4
+# %% ../nbs/api/04_export.ipynb
 class ExportModuleProc:
     "A processor which exports code to a module"
     def begin(self): self.modules,self.in_all = defaultdict(L),defaultdict(L)
@@ -24,9 +26,13 @@ class ExportModuleProc:
     def _export_(self, cell, exp_to=None):
         self._exporti_(cell, exp_to)
         self.in_all[ifnone(exp_to, '#')].append(cell)
+    def __call__(self, cell):
+        src = cell.source
+        if not src: return
+        if cell.cell_type=='markdown' and src.startswith('# '): self.modules['#'].append(cell)
     _exports_=_export_
 
-# %% ../nbs/api/04_export.ipynb 8
+# %% ../nbs/api/04_export.ipynb
 def black_format(cell, # Cell to format
                  force=False): # Turn black formatting on regardless of settings.ini
     "Processor to format code with `black`"
@@ -40,7 +46,7 @@ def black_format(cell, # Cell to format
         try: cell.source = _format_str(cell.source).strip()
         except: pass
 
-# %% ../nbs/api/04_export.ipynb 10
+# %% ../nbs/api/04_export.ipynb
 # includes the newline, because calling .strip() would affect all cells.
 _magics_pattern = re.compile(r'^\s*(%%|%).*\n?', re.MULTILINE)
 
@@ -52,14 +58,14 @@ def scrub_magics(cell): # Cell to format
     try: cell.source = _magics_pattern.sub('', cell.source)
     except: pass
 
-# %% ../nbs/api/04_export.ipynb 13
+# %% ../nbs/api/04_export.ipynb
 import nbdev.export
 def optional_procs():
     "An explicit list of processors that could be used by `nb_export`"
     return L([p for p in nbdev.export.__all__
               if p not in ["nb_export", "ExportModuleProc", "optional_procs"]])
 
-# %% ../nbs/api/04_export.ipynb 16
+# %% ../nbs/api/04_export.ipynb
 def nb_export(nbname, lib_path=None, procs=None, debug=False, mod_maker=ModuleMaker, name=None):
     "Create module(s) from notebook"
     if lib_path is None: lib_path = get_config().lib_path
@@ -67,12 +73,13 @@ def nb_export(nbname, lib_path=None, procs=None, debug=False, mod_maker=ModuleMa
     nb = NBProcessor(nbname, [exp]+L(procs), debug=debug)
     nb.process()
     for mod,cells in exp.modules.items():
-        all_cells = exp.in_all[mod]
-        nm = ifnone(name, getattr(exp, 'default_exp', None) if mod=='#' else mod)
-        if not nm:
-            warn(f"Notebook '{nbname}' uses `#|export` without `#|default_exp` cell.\n"
-                 "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
-                 "See https://nbdev.fast.ai/getting_started.html for more information.")
-            return
-        mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#')
-        mm.make(cells, all_cells, lib_path=lib_path)
+        if first(1 for o in cells if o.cell_type=='code'):
+            all_cells = exp.in_all[mod]
+            nm = ifnone(name, getattr(exp, 'default_exp', None) if mod=='#' else mod)
+            if not nm:
+                warn(f"Notebook '{nbname}' uses `#|export` without `#|default_exp` cell.\n"
+                     "Note nbdev2 no longer supports nbdev1 syntax. Run `nbdev_migrate` to upgrade.\n"
+                     "See https://nbdev.fast.ai/getting_started.html for more information.")
+                return
+            mm = mod_maker(dest=lib_path, name=nm, nb_path=nbname, is_new=bool(name) or mod=='#')
+            mm.make(cells, all_cells, lib_path=lib_path)

{nbdev-2.3.27 → nbdev-2.3.28}/nbdev/frontmatter.py

@@ -1,9 +1,11 @@
+"""A YAML and formatted-markdown frontmatter processor"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/09_frontmatter.ipynb.
 
 # %% auto 0
 __all__ = ['FrontmatterProc']
 
-# %% ../nbs/api/09_frontmatter.ipynb 2
+# %% ../nbs/api/09_frontmatter.ipynb
 from .imports import *
 from .process import *
 from .doclinks import _nbpath2html
@@ -12,7 +14,7 @@ from execnb.nbio import *
 from fastcore.imports import *
 import yaml
 
-# %% ../nbs/api/09_frontmatter.ipynb 5
+# %% ../nbs/api/09_frontmatter.ipynb
 _RE_FM_BASE=r'''^---\s*
 (.*?\S+.*?)
 ---\s*'''
@@ -40,7 +42,7 @@ def _md2dict(s:str):
         except Exception as e: warn(f'Failed to create YAML dict for:\n{r}\n\n{e}\n')
     return res
 
-# %% ../nbs/api/09_frontmatter.ipynb 6
+# %% ../nbs/api/09_frontmatter.ipynb
 def _dict2fm(d): return f'---\n{yaml.dump(d)}\n---\n\n'
 def _insertfm(nb, fm): nb.cells.insert(0, mk_cell(_dict2fm(fm), 'raw'))