fixes #1553

Author: jph00

nbdev/clean.py

@@ -26,7 +26,7 @@ def nbdev_trust(
     fname:str=None,  # A notebook name or glob to trust
     force_all:bool=False  # Also trust notebooks that haven't changed
 ):
-    "Trust notebooks matching `fname`"
+    "Trust notebooks matching `fname`."
     try: from nbformat.sign import NotebookNotary
     except:
         import warnings
@@ -100,6 +100,8 @@ def clean_nb(
     if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):
         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}
+    # Cell IDs were added in nbformat 4.5
+    if nb.get('nbformat') == 4 and nb.get('nbformat_minor', 0) < 5: nb['nbformat_minor'] = 5
 
 # %% ../nbs/api/11_clean.ipynb #604d83e6
 def _reconfigure(*strms):

nbs/api/04_export.ipynb

@@ -392,5 +392,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/api/07_merge.ipynb

@@ -676,5 +676,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/api/11_clean.ipynb

@@ -83,7 +83,7 @@
     "    fname:str=None,  # A notebook name or glob to trust\n",
     "    force_all:bool=False  # Also trust notebooks that haven't changed\n",
     "):\n",
-    "    \"Trust notebooks matching `fname`\"\n",
+    "    \"Trust notebooks matching `fname`.\"\n",
     "    try: from nbformat.sign import NotebookNotary\n",
     "    except:\n",
     "        import warnings\n",
@@ -221,7 +221,9 @@
     "    for c in nb['cells']: _clean_cell(c, clear_all, cell_metadata_keys, clean_ids)\n",
     "    if nb.get('metadata', {}).get('kernelspec', {}).get('name', None):\n",
     "        nb['metadata']['kernelspec']['display_name'] = nb[\"metadata\"][\"kernelspec\"][\"name\"]\n",
-    "    nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}"
+    "    nb['metadata'] = {k:v for k,v in nb['metadata'].items() if k in metadata_keys}\n",
+    "    # Cell IDs were added in nbformat 4.5\n",
+    "    if nb.get('nbformat') == 4 and nb.get('nbformat_minor', 0) < 5: nb['nbformat_minor'] = 5"
    ]
   },
   {

nbs/api/18_release.ipynb

@@ -939,5 +939,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/explanations/config.ipynb

@@ -116,7 +116,6 @@
        "| jupyter_hooks | bool_arg | False | Run Jupyter hooks? |\n",
        "| clean_ids | bool_arg | True | Remove ids from plaintext reprs? |\n",
        "| clear_all | bool_arg | False | Remove all cell metadata and cell outputs? |\n",
-       "| cell_number | bool_arg | True | Add cell number to the exported file |\n",
        "| put_version_in_init | bool_arg | True | Add the version to the main __init__.py in nbdev_export |\n",
        "| skip_procs | str |  | A list of processors that you want to skip |"
       ],
@@ -170,5 +169,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/explanations/directives.ipynb

@@ -787,5 +787,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/explanations/docs.ipynb

@@ -602,5 +602,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/getting_started.ipynb

@@ -39,7 +39,7 @@
    "source": [
     "- **Documentation** is automatically generated using [Quarto](https://quarto.org/) and hosted on [GitHub Pages](https://pages.github.com/). Docs support LaTeX, are searchable, and are automatically hyperlinked (including out-of-the-box support for many packages via [`nbdev-index`](https://github.com/fastai/nbdev-index))\n",
     "- **Publish packages to PyPI and conda** as well as tools to simplify package releases.  Python best practices are automatically followed, for example, only exported objects are included in `__all__`\n",
-    "- **Two-way sync between notebooks and plaintext source code** allowing you to use your IDE for code navigation or quick edits\n",
+    "- **Two-way sync between notebooks and plaintext source code** allowing you to use your IDE for code navigation or quick edits. Sync is robust: each exported cell is tagged with its unique notebook cell ID, so `nbdev_update` always updates the correct cell\n",
     "- **Tests** written as ordinary notebook cells are run in parallel with a single command\n",
     "- **Continuous integration** out-of-the-box with [GitHub Actions](https://github.com/features/actions) that run your tests and rebuild your docs\n",
     "- **Git-friendly notebooks** with [Jupyter/Git hooks](https://nbdev.fast.ai/tutorials/git_friendly_jupyter.html) that clean unwanted metadata and render merge conflicts in a human-readable format\n",
@@ -294,13 +294,7 @@
    ]
   }
  ],
- "metadata": {
-  "kernelspec": {
-   "display_name": "python3",
-   "language": "python",
-   "name": "python3"
-  }
- },
+ "metadata": {},
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }

nbs/tutorials/migrating.ipynb

@@ -268,5 +268,5 @@
   }
  },
  "nbformat": 4,
- "nbformat_minor": 4
+ "nbformat_minor": 5
 }