fixes #1440

Author: jph00

nbdev/_modidx.py

@@ -71,6 +71,7 @@
                                 '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/clean.py

@@ -1,3 +1,5 @@
+"""Strip superfluous metadata from notebooks"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/11_clean.ipynb.
 
 # %% auto 0

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

nbdev/config.py

@@ -1,16 +1,11 @@
-"""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.
 
 # %% auto 0
 __all__ = ['nbdev_create_config', 'get_config', 'config_key', 'create_output', 'show_src', 'update_version', 'add_init',
            'write_cells']
 
-# %% ../nbs/api/01_config.ipynb
-_doc_ = """Read and write nbdev's `settings.ini` file.
-`get_config` is the main function for reading settings."""
-
 # %% ../nbs/api/01_config.ipynb
 from datetime import datetime
 from fastcore.docments import *
@@ -255,7 +250,7 @@ def add_init(path=None):
 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}')
 

nbdev/doclinks.py

@@ -1,3 +1,5 @@
+"""Generating a documentation index from a module"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/05_doclinks.ipynb.
 
 # %% auto 0

nbdev/export.py

@@ -1,3 +1,5 @@
+"""Exporting a notebook to a library"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/04_export.ipynb.
 
 # %% auto 0
@@ -24,6 +26,10 @@ def _exporti_(self, cell, exp_to=None): self.modules[ifnone(exp_to, '#')].append
     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
@@ -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/frontmatter.py

@@ -1,3 +1,5 @@
+"""A YAML and formatted-markdown frontmatter processor"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/09_frontmatter.ipynb.
 
 # %% auto 0

nbdev/maker.py

@@ -1,3 +1,5 @@
+"""Create one or more modules from selected notebook cells"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/02_maker.ipynb.
 
 # %% ../nbs/api/02_maker.ipynb 1
@@ -175,13 +177,13 @@ def _import2relative(cells, lib_name=None):
 
 # %% ../nbs/api/02_maker.ipynb
 def _retr_mdoc(cells):
-    "Search for `_doc_` variable, used to create module docstring"
-    trees = L(cells).map(NbCell.parsed_).concat()
-    for o in trees:
-        if isinstance(o, _assign_types) and getattr(_targets(o)[0],'id',None)=='_doc_':
-            v = try_attrs(o.value, 'value', 's') # py37 uses `ast.Str.s`
-            return f'"""{v}"""\n\n' 
-    return ""
+    "Search for md meta quote line, used to create module docstring"
+    md1 = first(o for o in cells if o.cell_type=='markdown' and o.source.startswith('# '))
+    if not md1: return ''
+    summ = first(o for o in md1.source.splitlines() if o.startswith('> '))
+    if not summ: return ''
+    summ = summ.lstrip('> ').strip()
+    return f'"""{summ}"""\n\n' if summ else ''
 
 # %% ../nbs/api/02_maker.ipynb
 @patch

nbdev/merge.py

@@ -1,3 +1,5 @@
+"""Fix merge conflicts in jupyter notebooks"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/07_merge.ipynb.
 
 # %% auto 0

nbdev/migrate.py

@@ -1,3 +1,5 @@
+"""Utilities for migrating to nbdev"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/16_migrate.ipynb.
 
 # %% auto 0