nbdev 3.0.15__tar.gz → 3.0.17__tar.gz

{nbdev-3.0.15/nbdev.egg-info → nbdev-3.0.17}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.15
+Version: 3.0.17
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/__init__.py

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

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/_modidx.py

@@ -52,6 +52,8 @@ d = { 'settings': { 'branch': 'main',
                               'nbdev.config.import_obj': ('api/config.html#import_obj', 'nbdev/config.py'),
                               'nbdev.config.is_nbdev': ('api/config.html#is_nbdev', 'nbdev/config.py'),
                               'nbdev.config.nbdev_create_config': ('api/config.html#nbdev_create_config', 'nbdev/config.py'),
+                              'nbdev.config.nbpath2docurl': ('api/config.html#nbpath2docurl', 'nbdev/config.py'),
+                              'nbdev.config.nbpath2html': ('api/config.html#nbpath2html', 'nbdev/config.py'),
                               'nbdev.config.read_version': ('api/config.html#read_version', 'nbdev/config.py'),
                               'nbdev.config.set_version': ('api/config.html#set_version', 'nbdev/config.py'),
                               'nbdev.config.show_src': ('api/config.html#show_src', 'nbdev/config.py'),
@@ -82,7 +84,6 @@ d = { 'settings': { 'branch': 'main',
                                 'nbdev.doclinks._get_modidx': ('api/doclinks.html#_get_modidx', 'nbdev/doclinks.py'),
                                 'nbdev.doclinks._iter_py_cells': ('api/doclinks.html#_iter_py_cells', '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'),

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/clean.py

@@ -1,4 +1,6 @@
-"""Strip superfluous metadata from notebooks"""
+"""Strip superfluous metadata from notebooks
+
+Docs: https://nbdev.fast.ai/api/clean.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/11_clean.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/cli.py

@@ -1,4 +1,6 @@
-"""CLI commands"""
+"""CLI commands
+
+Docs: https://nbdev.fast.ai/api/cli.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/13_cli.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/config.py

@@ -1,11 +1,13 @@
-"""Configuring nbdev and bootstrapping notebook export"""
+"""Configuring nbdev and bootstrapping notebook export
+
+Docs: https://nbdev.fast.ai/api/config.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/01_config.ipynb.
 
 # %% auto #0
 __all__ = ['pyproject_nm', 'pyproject_tmpl', 'nbdev_defaults', 'pyproj_tmpl', 'nbdev_create_config', 'ConfigToml', 'get_config',
-           'is_nbdev', 'create_output', 'show_src', 'read_version', 'set_version', 'bump_version', 'update_version',
-           'update_proj', 'add_init', 'import_obj', 'write_cells']
+           'is_nbdev', 'create_output', 'show_src', 'nbpath2html', 'nbpath2docurl', 'read_version', 'set_version',
+           'bump_version', 'update_version', 'update_proj', 'add_init', 'import_obj', 'write_cells']
 
 # %% ../nbs/api/01_config.ipynb #6fd14ecd
 from datetime import datetime
@@ -16,7 +18,7 @@ from fastcore.script import *
 from fastcore.style import *
 from fastcore.xdg import *
 
-import ast,importlib,warnings
+import ast,importlib,re,warnings
 from IPython.display import Markdown
 from fastcore.nbio import read_nb,NbCell
 from urllib.error import HTTPError
@@ -254,6 +256,20 @@ def create_output(txt, mime):
 # %% ../nbs/api/01_config.ipynb #5a4d8e52
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
+# %% ../nbs/api/01_config.ipynb #14a9c607
+def nbpath2html(p):
+    "Convert notebook path `p` to its html doc path (strips numeric prefix)"
+    p = Path(p)
+    return p.with_name(re.sub(r'^\d+[a-zA-Z0-9]*_', '', p.name.lower())).with_suffix('.html')
+
+# %% ../nbs/api/01_config.ipynb #c830bb2b
+def nbpath2docurl(nb_path):
+    "Hosted docs URL (with `.md` suffix) for notebook `nb_path`, or '' if no `doc_host`"
+    cfg = get_config()
+    if not cfg.doc_host: return ''
+    p = Path(nb_path).resolve().relative_to(cfg.path('nbs_path'))
+    return f"{cfg.doc_host.rstrip('/')}{cfg.doc_baseurl}{nbpath2html(p).as_posix()}.md"
+
 # %% ../nbs/api/01_config.ipynb #163177f2
 pyproj_tmpl = """[build-system]
 requires = ["setuptools>=64.0"]

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/diff.py

@@ -1,4 +1,6 @@
-"""Get ipynb diffs by cell"""
+"""Get ipynb diffs by cell
+
+Docs: https://nbdev.fast.ai/api/diff.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/19_diff.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/doclinks.py

@@ -1,4 +1,6 @@
-"""Generating a documentation index from a module"""
+"""Generating a documentation index from a module
+
+Docs: https://nbdev.fast.ai/api/doclinks.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/05_doclinks.ipynb.
 
@@ -70,9 +72,6 @@ def _iter_py_cells(p):
         if code.endswith('\n'): code=code[:-1]
         yield AttrDict(nb=nb, cell_id=cell_id, code=code, nb_path=nb_path, py_path=p.resolve())
 
-# %% ../nbs/api/05_doclinks.ipynb #d1c22276
-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 #f57b8709
 def _get_modidx(py_path, code_root, nbs_path):
     "Get module symbol index for a Python source file"
@@ -84,7 +83,7 @@ def _get_modidx(py_path, code_root, nbs_path):
     d = {}
     for cell in _iter_py_cells(py_path):
         if 'auto' in cell.nb: continue
-        loc = _nbpath2html(cell.nb_path.relative_to(nbs_path))
+        loc = nbpath2html(cell.nb_path.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

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/export.py

@@ -1,4 +1,6 @@
-"""Exporting a notebook to a library"""
+"""Exporting a notebook to a library
+
+Docs: https://nbdev.fast.ai/api/export.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/04_export.ipynb.
 
@@ -30,7 +32,7 @@ class ExportModuleProc:
     def __call__(self, cell):
         src = cell.source
         if not src: return
-        if cell.cell_type=='markdown' and src.startswith('# '): self.modules['#'].append(cell)
+        if cell.cell_type=='markdown' and (src.startswith('# ') or 'export' in cell.directives_): self._exporti_(cell)
     _exports_=_export_
 
 # %% ../nbs/api/04_export.ipynb #76717e36

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/frontmatter.py

@@ -1,4 +1,6 @@
-"""A YAML and formatted-markdown frontmatter processor"""
+"""A YAML and formatted-markdown frontmatter processor
+
+Docs: https://nbdev.fast.ai/api/frontmatter.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/09_frontmatter.ipynb.
 
@@ -8,7 +10,7 @@ __all__ = ['nb_frontmatter', 'FrontmatterProc']
 # %% ../nbs/api/09_frontmatter.ipynb #2398f5ef-06d3-4890-8a54-7cf4f81f3894
 from .imports import *
 from .process import *
-from .doclinks import _nbpath2html
+from .config import nbpath2html
 
 from fastcore.nbio import *
 from fastcore.imports import *
@@ -80,5 +82,5 @@ class FrontmatterProc(Processor):
                                  'from your _quarto.yml file (e.g. `ipynb-filter: [nbdev_filter]`), since they are no '
                                  'longer supported as of nbdev v2.3. See the v2.3 launch post for more information: '
                                  'https://forums.fast.ai/t/upcoming-changes-in-v2-3-edit-now-released/98905.')
-        self.fm.update({'output-file': _nbpath2html(Path(self.nb.path_)).name})
+        self.fm.update({'output-file': nbpath2html(Path(self.nb.path_)).name})
         _insertfm(self.nb, self.fm)

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/maker.py

@@ -1,4 +1,6 @@
-"""Create one or more modules from selected notebook cells"""
+"""Create one or more modules from selected notebook cells
+
+Docs: https://nbdev.fast.ai/api/maker.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/02_maker.ipynb.
 
@@ -111,7 +113,7 @@ def make_code_cells(*ss): return dict2nb({'cells':L(ss).map(mk_cell)}).cells
 # %% ../nbs/api/02_maker.ipynb #a2546836
 def relative_import(name, fname, level=0):
     "Convert a module `name` to a name relative to `fname`"
-    assert not level
+    if level: raise ValueError(f"nbdev export does not support relative imports: module={name}, export_path={fname}")
     sname = name.replace('.','/')
     if not(os.path.commonpath([sname,fname])): return name
     rel = os.path.relpath(sname, fname)
@@ -174,15 +176,18 @@ def _import2relative(cells, lib_path=None):
     for cell in cells: cell.import2relative(lib_path)
 
 # %% ../nbs/api/02_maker.ipynb #5bff9d71
-def _retr_mdoc(cells):
-    "Search for md meta quote lines, used to create module docstring"
+def _retr_mdoc(cells, nb_path=None):
+    "Search for markdown cells 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 ''
     lines = dropwhile(lambda l: not l.startswith('> '), md1.source.splitlines())
     lines = list(takewhile(lambda l: l.startswith('> '), lines))
-    if not lines: return ''
     summ = '\n'.join(l.lstrip('> ').strip() for l in lines)
-    return f'"""{summ}"""\n\n' if summ else ''
+    docs = L(o.source.rstrip() for o in cells if o.cell_type=='markdown' and 'export' in getattr(o,'directives_',{}))
+    mdoc = '\n\n'.join(L(summ)+docs).strip()
+    url = nbpath2docurl(nb_path) if nb_path else ''
+    if url: mdoc = (mdoc + f'\n\nDocs: {url}').strip()
+    return f'"""{mdoc}"""\n\n' if mdoc else ''
 
 # %% ../nbs/api/02_maker.ipynb #cdd205d6
 @patch
@@ -204,7 +209,7 @@ def make(self:ModuleMaker, cells, all_cells=None, lib_path=None):
         tw = TextWrapper(width=120, initial_indent='', subsequent_indent=' '*11, break_long_words=False)
         all_str = '\n'.join(tw.wrap(str(_all)))
     with self.fname.open('w', encoding="utf-8") as f:
-        f.write(_retr_mdoc(cells))
+        f.write(_retr_mdoc(cells, self.nb_path))
         f.write(f"# AUTOGENERATED! DO NOT EDIT! File to edit: {self.dest2nb}.")
         if last_future > 0: write_cells(cells[:last_future], self.hdr, f)
         if self.parse and not self.solo_nb: f.write(f"\n\n# %% auto #0\n__all__ = {all_str}")

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/merge.py

@@ -1,4 +1,6 @@
-"""Fix merge conflicts in jupyter notebooks"""
+"""Fix merge conflicts in jupyter notebooks
+
+Docs: https://nbdev.fast.ai/api/merge.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/07_merge.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/migrate.py

@@ -1,4 +1,6 @@
-"""Utilities for migrating to nbdev"""
+"""Utilities for migrating to nbdev
+
+Docs: https://nbdev.fast.ai/api/migrate.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/16_migrate.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/process.py

@@ -1,4 +1,6 @@
-"""A notebook processor"""
+"""A notebook processor
+
+Docs: https://nbdev.fast.ai/api/process.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/03_process.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/processors.py

@@ -1,4 +1,6 @@
-"""Some processors for NBProcessor"""
+"""Some processors for NBProcessor
+
+Docs: https://nbdev.fast.ai/api/processors.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/10_processors.ipynb.
 
@@ -198,8 +200,9 @@ def rm_header_dash(cell):
 _hide_dirs = {'export','exporti', 'hide','default_exp'}
 
 def rm_export(cell):
-    "Remove cells that are exported or hidden"
-    if cell.directives_ and (cell.directives_.keys() & _hide_dirs): del(cell['source'])
+    "Remove code cells that are exported or hidden"
+    if cell.cell_type=='code' and cell.directives_ and (cell.directives_.keys() & _hide_dirs): del(cell['source'])
+
 
 # %% ../nbs/api/10_processors.ipynb #2d9a0a30
 _re_showdoc = re.compile(r'^show_doc', re.MULTILINE)

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/qmd.py

@@ -1,4 +1,6 @@
-"""Basic qmd generation helpers (experimental)"""
+"""Basic qmd generation helpers (experimental)
+
+Docs: https://nbdev.fast.ai/api/qmd.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/15_qmd.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/quarto.py

@@ -1,4 +1,6 @@
-"""Install and interact with Quarto from nbdev"""
+"""Install and interact with Quarto from nbdev
+
+Docs: https://nbdev.fast.ai/api/quarto.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/14_quarto.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/release.py

@@ -1,4 +1,6 @@
-"""Auto-generated tagged releases and release notes from GitHub issues"""
+"""Auto-generated tagged releases and release notes from GitHub issues
+
+Docs: https://nbdev.fast.ai/api/release.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/18_release.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/serve.py

@@ -1,4 +1,6 @@
-"""A parallel ipynb processor (experimental)"""
+"""A parallel ipynb processor (experimental)
+
+Docs: https://nbdev.fast.ai/api/serve.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/17_serve.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/showdoc.py

@@ -1,4 +1,6 @@
-"""Display symbol documentation in notebook and website"""
+"""Display symbol documentation in notebook and website
+
+Docs: https://nbdev.fast.ai/api/showdoc.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/08_showdoc.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/sync.py

@@ -1,4 +1,6 @@
-"""Propagate small changes in the library back to notebooks"""
+"""Propagate small changes in the library back to notebooks
+
+Docs: https://nbdev.fast.ai/api/sync.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/06_sync.ipynb.
 

{nbdev-3.0.15 → nbdev-3.0.17}/nbdev/test.py

@@ -1,4 +1,6 @@
-"""Run unit tests on notebooks in parallel"""
+"""Run unit tests on notebooks in parallel
+
+Docs: https://nbdev.fast.ai/api/test.html.md"""
 
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/api/12_test.ipynb.
 
@@ -6,7 +8,7 @@
 __all__ = ['test_nb', 'nbdev_test']
 
 # %% ../nbs/api/12_test.ipynb #45e10c3f
-import time,os,sys,traceback,contextlib, inspect
+import time,os,sys,traceback,contextlib,inspect,faulthandler,signal
 from fastcore.basics import *
 from fastcore.imports import *
 from fastcore.foundation import *
@@ -32,6 +34,7 @@ def test_nb(fn,  # file name of notebook to test
             verbose=False,  # stream stdout/stderr from cells to console?
             save=False):  # write outputs back to notebook on success?
     "Execute tests in notebook in `fn` except those with `skip_flags`"
+    faulthandler.register(signal.SIGINT, file=sys.__stderr__, all_threads=True, chain=True)
     if basepath: sys.path.insert(0, str(basepath))
     if not IN_NOTEBOOK: os.environ["IN_TEST"] = '1'
     flags=set(L(skip_flags)) - set(L(force_flags))

{nbdev-3.0.15 → nbdev-3.0.17/nbdev.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.0.15
+Version: 3.0.17
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0

{nbdev-3.0.15 → nbdev-3.0.17}/pyproject.toml

@@ -76,7 +76,7 @@ version = {attr = "nbdev.__version__"}
 include = ["nbdev"]
 
 [tool.nbdev]
-allowed_metadata_keys = ['solveit_dialog_mode', 'solveit_ver']
+allowed_metadata_keys = ['solveit']
 custom_sidebar = true
 readme_nb = "getting_started.ipynb"
 jupyter_hooks = true