nbdev 3.1.0__tar.gz → 3.2.1__tar.gz

{nbdev-3.1.0/nbdev.egg-info → nbdev-3.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nbdev
-Version: 3.1.0
+Version: 3.2.1
 Summary: Create delightful software with Jupyter Notebooks
 Author-email: "Jeremy Howard and the fast.ai community" <j@fast.ai>
 License: Apache-2.0
@@ -16,7 +16,7 @@ Classifier: License :: OSI Approved :: Apache Software License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: fastcore>=1.14.1
+Requires-Dist: fastcore>=1.14.6
 Requires-Dist: execnb>=0.2.4
 Requires-Dist: astunparse
 Requires-Dist: ghapi>=2.0.0
@@ -36,7 +36,7 @@ Requires-Dist: matplotlib; extra == "dev"
 Requires-Dist: black; extra == "dev"
 Requires-Dist: svg.py; extra == "dev"
 Requires-Dist: nbclassic; extra == "dev"
-Requires-Dist: pysymbol_llm; extra == "dev"
+Requires-Dist: pysym2md>=0.0.6; extra == "dev"
 Requires-Dist: llms-txt; extra == "dev"
 Requires-Dist: sphinx; extra == "dev"
 Requires-Dist: plum-dispatch; extra == "dev"
@@ -51,55 +51,25 @@ Dynamic: license-file
 
 ## 🛑**Jan 2026 Major Version Update – Breaking Change**🛑
 
-**nbdev3 is here!** As many of you have been requesting, configuration
-has moved from `settings.ini` to `pyproject.toml`, following modern
-Python packaging standards ([PEP
-621](https://peps.python.org/pep-0621/)). Your project metadata now
-lives in the standard `[project]` section, while nbdev-specific settings
-go in `[tool.nbdev]`.
-
-**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project
-root to automatically convert your `settings.ini` to `pyproject.toml`
-and update your GitHub Actions workflows to use nbdev3-compatible
-versions. Your existing notebooks and code don’t need any changes.
-
-`nbdev` is a notebook-driven development platform. Simply write
-notebooks with lightweight markup and get high-quality documentation,
-tests, continuous integration, and packaging for free!
-
-`nbdev` makes debugging and refactoring your code much easier than in
-traditional programming environments since you always have live objects
-at your fingertips. `nbdev` also promotes software engineering best
-practices because tests and documentation are first class.
-
-- **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))
-- **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__`
-- **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
-- **Tests** written as ordinary notebook cells are run in parallel with
-  a single command
-- **Continuous integration** out-of-the-box with [GitHub
-  Actions](https://github.com/features/actions) that run your tests and
-  rebuild your docs
-- **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
+**nbdev3 is here!** As many of you have been requesting, configuration has moved from `settings.ini` to `pyproject.toml`, following modern Python packaging standards ([PEP 621](https://peps.python.org/pep-0621/)). Your project metadata now lives in the standard `[project]` section, while nbdev-specific settings go in `[tool.nbdev]`.
+
+**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project root to automatically convert your `settings.ini` to `pyproject.toml` and update your GitHub Actions workflows to use nbdev3-compatible versions. Your existing notebooks and code don’t need any changes.
+
+`nbdev` is a notebook-driven development platform. Simply write notebooks with lightweight markup and get high-quality documentation, tests, continuous integration, and packaging for free!
+
+`nbdev` makes debugging and refactoring your code much easier than in traditional programming environments since you always have live objects at your fingertips. `nbdev` also promotes software engineering best practices because tests and documentation are first class.
+
+- **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))
+- **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__`
+- **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
+- **Tests** written as ordinary notebook cells are run in parallel with a single command
+- **Continuous integration** out-of-the-box with [GitHub Actions](https://github.com/features/actions) that run your tests and rebuild your docs
+- **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
 - … and much more!
 
 ## Install
 
-nbdev works on macOS, Linux, and most Unix-style operating systems. It
-works on Windows under WSL, but not under cmd or Powershell.
+nbdev works on macOS, Linux, and most Unix-style operating systems. It works on Windows under WSL, but not under cmd or Powershell.
 
 You can install nbdev with pip:
 
@@ -107,27 +77,17 @@ You can install nbdev with pip:
 pip install nbdev
 ```
 
-Note that `nbdev` must be installed into the same Python environment
-that you use for both Jupyter and your project.
+Note that `nbdev` must be installed into the same Python environment that you use for both Jupyter and your project.
 
 ## How to use nbdev
 
-The best way to learn how to use nbdev is to complete either the
-[written walkthrough](https://nbdev.fast.ai/tutorials/tutorial.html) or
-video walkthrough:
+The best way to learn how to use nbdev is to complete either the [written walkthrough](https://nbdev.fast.ai/tutorials/tutorial.html) or video walkthrough:
 
-<a href="http://www.youtube.com/watch?v=l7zS8Ld4_iA" target="_blank"
-title="nbdev walkthrough"><img
-src="https://github.com/fastai/logos/raw/main/nbdev_walkthrough.png"
-style="border-radius: 10px" width="560" height="315" /></a>
+<a href="http://www.youtube.com/watch?v=l7zS8Ld4_iA" target="_blank" title="nbdev walkthrough"><img src="https://github.com/fastai/logos/raw/main/nbdev_walkthrough.png" style="border-radius: 10px" width="560" height="315" /></a>
 
-Alternatively, there’s a [shortened version of the video
-walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up
-using the `unsilence` Python library – it’s 27 minutes faster, but a bit
-harder to follow.
+Alternatively, there’s a [shortened version of the video walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up using the `unsilence` Python library – it’s 27 minutes faster, but a bit harder to follow.
 
-You can also run `nbdev-help` from the terminal to see the full list of
-available commands:
+You can also run `nbdev-help` from the terminal to see the full list of available commands:
 
 ``` python
 !nbdev-help
@@ -158,7 +118,7 @@ available commands:
     nbdev-pypi                Create and upload Python package to PyPI
     nbdev-readme              Create README.md from readme_nb (index.ipynb by default)
     nbdev-release-both        Release both conda and PyPI packages
-    nbdev-release-gh          Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
+    nbdev-release-gh          Calls `nbdev-changelog`, lets you edit the result, then pushes to git and calls `nbdev-release-git`
     nbdev-release-git         Tag and create a release in GitHub for the current version
     nbdev-requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
     nbdev-sidebar             Create sidebar.yml
@@ -172,42 +132,26 @@ available commands:
 
 ### Q: What is the warning “Found a cell containing mix of imports and computations. Please use separate cells”?
 
-A: You should not have cells that are not exported, *and* contain a mix
-of `import` statements along with other code. For instance, don’t do
-this in a single cell:
+A: You should not have cells that are not exported, *and* contain a mix of `import` statements along with other code. For instance, don’t do this in a single cell:
 
 ``` python
 import some_module
 some_module.something()
 ```
 
-Instead, split this into two cells, one which does `import some_module`,
-and the other which does `some_module.something()`.
+Instead, split this into two cells, one which does `import some_module`, and the other which does `some_module.something()`.
+
+Only top-level statements count: `try: import` blocks and imports inside function definitions are fine.
 
-The reason for this is that when we create your documentation website,
-we ensure that all of the signatures for functions you document are up
-to date, by running the imports, exported cells, and
-[`show_doc`](https://nbdev.fast.ai/api/showdoc.html#show_doc) functions
-in your notebooks. When you mix imports with other code, that other code
-will be run too, which can cause errors (or at least slowdowns) when
-creating your website.
+The reason for this is that when we create your documentation website, we ensure that all of the signatures for functions you document are up to date, by running the imports, exported cells, and [`show_doc`](https://nbdev.fast.ai/api/showdoc.html#show_doc) functions in your notebooks. When you mix imports with other code, that other code will be run too, which can cause errors (or at least slowdowns) when creating your website.
 
 ### Q: Why is nbdev asking for root access? How do I install Quarto without root access?
 
-A: When you setup your first project, nbdev will attempt to
-automatically download and install [Quarto](https://quarto.org/) for
-you. This is the program that we use to create your documentation
-website.
+A: When you setup your first project, nbdev will attempt to automatically download and install [Quarto](https://quarto.org/) for you. This is the program that we use to create your documentation website.
 
-Quarto’s standard installation process requires root access, and nbdev
-will therefore ask for your root password during installation. For most
-people, this will work fine and everything will be handled automatically
-– if so, you can skip over the rest of this section, which talks about
-installing without root access.
+Quarto’s standard installation process requires root access, and nbdev will therefore ask for your root password during installation. For most people, this will work fine and everything will be handled automatically – if so, you can skip over the rest of this section, which talks about installing without root access.
 
-If you need to install Quarto without root access on Linux, first `cd`
-to wherever you want to store it, then [download
-Quarto](https://quarto.org/docs/get-started/), and type:
+If you need to install Quarto without root access on Linux, first `cd` to wherever you want to store it, then [download Quarto](https://quarto.org/docs/get-started/), and type:
 
 ``` bash
 dpkg -x quarto*.deb .
@@ -217,39 +161,18 @@ mkdir -p ~/.local/bin
 ln -s "$(pwd)"/quarto/bin/quarto ~/.local/bin
 ```
 
-To use this non-root version of Quarto, you’ll need `~/.local/bin` in
-your [`PATH` environment
-variable](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/).
-(Alternatively, change the `ln -s` step to place the symlink somewhere
-else in your path.)
+To use this non-root version of Quarto, you’ll need `~/.local/bin` in your [`PATH` environment variable](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/). (Alternatively, change the `ln -s` step to place the symlink somewhere else in your path.)
 
 ### Q: Someone told me not to use notebooks for “serious” software development!
 
-A: [Watch this video](https://youtu.be/9Q6sLbz37gk). Don’t worry, we
-still get this too, despite having used `nbdev` for a wide range of
-“very serious” software projects over the last three years, including
-[deep learning libraries](https://github.com/fastai/fastai), [API
-clients](https://github.com/fastai/ghapi), [Python language
-extensions](https://github.com/fastai/fastcore), [terminal user
-interfaces](https://github.com/nat/ghtop), and more!
+A: [Watch this video](https://youtu.be/9Q6sLbz37gk). Don’t worry, we still get this too, despite having used `nbdev` for a wide range of “very serious” software projects over the last three years, including [deep learning libraries](https://github.com/fastai/fastai), [API clients](https://github.com/fastai/ghapi), [Python language extensions](https://github.com/fastai/fastcore), [terminal user interfaces](https://github.com/nat/ghtop), and more!
 
 ## Contributing
 
-If you want to contribute to `nbdev`, be sure to review the
-[contributions
-guidelines](https://github.com/fastai/nbdev/blob/master/CONTRIBUTING.md).
-This project adheres to fastai’s [code of
-conduct](https://github.com/fastai/nbdev/blob/master/CODE_OF_CONDUCT.md).
-By participating, you are expected to uphold this code. In general, we
-strive to abide by generally accepted best practices in open-source
-software development.
+If you want to contribute to `nbdev`, be sure to review the [contributions guidelines](https://github.com/fastai/nbdev/blob/master/CONTRIBUTING.md). This project adheres to fastai’s [code of conduct](https://github.com/fastai/nbdev/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. In general, we strive to abide by generally accepted best practices in open-source software development.
 
-Make sure you have `nbdev`’s git hooks installed by running
-`nbdev-install-hooks` in the cloned repository.
+Make sure you have `nbdev`’s git hooks installed by running `nbdev-install-hooks` in the cloned repository.
 
 ## Copyright
 
-Copyright © 2019 onward fast.ai, Inc. Licensed under the Apache License,
-Version 2.0 (the “License”); you may not use this project’s files except
-in compliance with the License. A copy of the License is provided in the
-LICENSE file in this repository.
+Copyright © 2019 onward fast.ai, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this project’s files except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.

nbdev-3.2.1/README.md

@@ -0,0 +1,134 @@
+# Getting Started
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+![CI](https://github.com/fastai/nbdev/actions/workflows/test.yaml/badge.svg)
+
+## 🛑**Jan 2026 Major Version Update – Breaking Change**🛑
+
+**nbdev3 is here!** As many of you have been requesting, configuration has moved from `settings.ini` to `pyproject.toml`, following modern Python packaging standards ([PEP 621](https://peps.python.org/pep-0621/)). Your project metadata now lives in the standard `[project]` section, while nbdev-specific settings go in `[tool.nbdev]`.
+
+**Migrating from nbdev2:** Run `nbdev-migrate-config` in your project root to automatically convert your `settings.ini` to `pyproject.toml` and update your GitHub Actions workflows to use nbdev3-compatible versions. Your existing notebooks and code don’t need any changes.
+
+`nbdev` is a notebook-driven development platform. Simply write notebooks with lightweight markup and get high-quality documentation, tests, continuous integration, and packaging for free!
+
+`nbdev` makes debugging and refactoring your code much easier than in traditional programming environments since you always have live objects at your fingertips. `nbdev` also promotes software engineering best practices because tests and documentation are first class.
+
+- **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))
+- **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__`
+- **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
+- **Tests** written as ordinary notebook cells are run in parallel with a single command
+- **Continuous integration** out-of-the-box with [GitHub Actions](https://github.com/features/actions) that run your tests and rebuild your docs
+- **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
+- … and much more!
+
+## Install
+
+nbdev works on macOS, Linux, and most Unix-style operating systems. It works on Windows under WSL, but not under cmd or Powershell.
+
+You can install nbdev with pip:
+
+``` sh
+pip install nbdev
+```
+
+Note that `nbdev` must be installed into the same Python environment that you use for both Jupyter and your project.
+
+## How to use nbdev
+
+The best way to learn how to use nbdev is to complete either the [written walkthrough](https://nbdev.fast.ai/tutorials/tutorial.html) or video walkthrough:
+
+<a href="http://www.youtube.com/watch?v=l7zS8Ld4_iA" target="_blank" title="nbdev walkthrough"><img src="https://github.com/fastai/logos/raw/main/nbdev_walkthrough.png" style="border-radius: 10px" width="560" height="315" /></a>
+
+Alternatively, there’s a [shortened version of the video walkthrough](https://youtu.be/67FdzLSt4aA) with coding sections sped up using the `unsilence` Python library – it’s 27 minutes faster, but a bit harder to follow.
+
+You can also run `nbdev-help` from the terminal to see the full list of available commands:
+
+``` python
+!nbdev-help
+```
+
+    nb-export                 Export a single nbdev notebook to a python script.
+    nbdev-bump-version        Increment version in __init__.py by one
+    nbdev-changelog           Create a CHANGELOG.md file from closed and labeled GitHub issues
+    nbdev-clean               Clean all notebooks in `fname` to avoid merge conflicts
+    nbdev-conda               Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
+    nbdev-contributing        Create CONTRIBUTING.md from contributing_nb (defaults to 'contributing.ipynb' if present). Skips if the file doesn't exist.
+    nbdev-create-config       Create a pyproject.toml config file.
+    nbdev-docs                Create Quarto docs and README.md
+    nbdev-export              Export notebooks in `path` to Python modules
+    nbdev-filter              A notebook filter for Quarto
+    nbdev-fix                 Create working notebook from conflicted notebook `nbname`
+    nbdev-help                Show help for all console scripts
+    nbdev-install             Install Quarto and the current library
+    nbdev-install-hooks       Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
+    nbdev-install-quarto      Install latest Quarto on macOS or Linux, prints instructions for Windows
+    nbdev-merge               Git merge driver for notebooks
+    nbdev-migrate             Convert all markdown and notebook files in `path` from v1 to v2
+    nbdev-migrate-config      Migrate settings.ini to pyproject.toml
+    nbdev-new                 Create an nbdev project.
+    nbdev-prepare             Export, test, and clean notebooks, and render README if needed
+    nbdev-preview             Preview docs locally
+    nbdev-proc-nbs            Process notebooks in `path` for docs rendering
+    nbdev-pypi                Create and upload Python package to PyPI
+    nbdev-readme              Create README.md from readme_nb (index.ipynb by default)
+    nbdev-release-both        Release both conda and PyPI packages
+    nbdev-release-gh          Calls `nbdev-changelog`, lets you edit the result, then pushes to git and calls `nbdev-release-git`
+    nbdev-release-git         Tag and create a release in GitHub for the current version
+    nbdev-requirements        Writes a `requirements.txt` file to `directory` based on pyproject.toml.
+    nbdev-sidebar             Create sidebar.yml
+    nbdev-test                Test in parallel notebooks matching `path`, passing along `flags`
+    nbdev-trust               Trust notebooks matching `fname`.
+    nbdev-update              Propagate change in modules matching `fname` to notebooks that created them
+    nbdev-update-license      Allows you to update the license of your project.
+    watch-export              Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available
+
+## FAQ
+
+### Q: What is the warning “Found a cell containing mix of imports and computations. Please use separate cells”?
+
+A: You should not have cells that are not exported, *and* contain a mix of `import` statements along with other code. For instance, don’t do this in a single cell:
+
+``` python
+import some_module
+some_module.something()
+```
+
+Instead, split this into two cells, one which does `import some_module`, and the other which does `some_module.something()`.
+
+Only top-level statements count: `try: import` blocks and imports inside function definitions are fine.
+
+The reason for this is that when we create your documentation website, we ensure that all of the signatures for functions you document are up to date, by running the imports, exported cells, and [`show_doc`](https://nbdev.fast.ai/api/showdoc.html#show_doc) functions in your notebooks. When you mix imports with other code, that other code will be run too, which can cause errors (or at least slowdowns) when creating your website.
+
+### Q: Why is nbdev asking for root access? How do I install Quarto without root access?
+
+A: When you setup your first project, nbdev will attempt to automatically download and install [Quarto](https://quarto.org/) for you. This is the program that we use to create your documentation website.
+
+Quarto’s standard installation process requires root access, and nbdev will therefore ask for your root password during installation. For most people, this will work fine and everything will be handled automatically – if so, you can skip over the rest of this section, which talks about installing without root access.
+
+If you need to install Quarto without root access on Linux, first `cd` to wherever you want to store it, then [download Quarto](https://quarto.org/docs/get-started/), and type:
+
+``` bash
+dpkg -x quarto*.deb .
+mv opt/quarto ./
+rmdir opt
+mkdir -p ~/.local/bin
+ln -s "$(pwd)"/quarto/bin/quarto ~/.local/bin
+```
+
+To use this non-root version of Quarto, you’ll need `~/.local/bin` in your [`PATH` environment variable](https://linuxize.com/post/how-to-add-directory-to-path-in-linux/). (Alternatively, change the `ln -s` step to place the symlink somewhere else in your path.)
+
+### Q: Someone told me not to use notebooks for “serious” software development!
+
+A: [Watch this video](https://youtu.be/9Q6sLbz37gk). Don’t worry, we still get this too, despite having used `nbdev` for a wide range of “very serious” software projects over the last three years, including [deep learning libraries](https://github.com/fastai/fastai), [API clients](https://github.com/fastai/ghapi), [Python language extensions](https://github.com/fastai/fastcore), [terminal user interfaces](https://github.com/nat/ghtop), and more!
+
+## Contributing
+
+If you want to contribute to `nbdev`, be sure to review the [contributions guidelines](https://github.com/fastai/nbdev/blob/master/CONTRIBUTING.md). This project adheres to fastai’s [code of conduct](https://github.com/fastai/nbdev/blob/master/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. In general, we strive to abide by generally accepted best practices in open-source software development.
+
+Make sure you have `nbdev`’s git hooks installed by running `nbdev-install-hooks` in the cloned repository.
+
+## Copyright
+
+Copyright © 2019 onward fast.ai, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this project’s files except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/__init__.py

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

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/_modidx.py

@@ -225,6 +225,7 @@ d = { 'settings': { 'branch': 'main',
                                   'nbdev.processors._is_showdoc': ('api/processors.html#_is_showdoc', 'nbdev/processors.py'),
                                   'nbdev.processors._re_hideline': ('api/processors.html#_re_hideline', 'nbdev/processors.py'),
                                   'nbdev.processors._show_docs': ('api/processors.html#_show_docs', 'nbdev/processors.py'),
+                                  'nbdev.processors._tl_contains': ('api/processors.html#_tl_contains', 'nbdev/processors.py'),
                                   'nbdev.processors._want_doc': ('api/processors.html#_want_doc', 'nbdev/processors.py'),
                                   'nbdev.processors.add_fold': ('api/processors.html#add_fold', 'nbdev/processors.py'),
                                   'nbdev.processors.add_links': ('api/processors.html#add_links', 'nbdev/processors.py'),
@@ -282,11 +283,13 @@ d = { 'settings': { 'branch': 'main',
                               'nbdev.quarto._copytree': ('api/quarto.html#_copytree', 'nbdev/quarto.py'),
                               'nbdev.quarto._doc_mtime_not_older': ('api/quarto.html#_doc_mtime_not_older', 'nbdev/quarto.py'),
                               'nbdev.quarto._ensure_quarto': ('api/quarto.html#_ensure_quarto', 'nbdev/quarto.py'),
+                              'nbdev.quarto._fix_quarto_nav': ('api/quarto.html#_fix_quarto_nav', 'nbdev/quarto.py'),
                               'nbdev.quarto._install_linux': ('api/quarto.html#_install_linux', 'nbdev/quarto.py'),
                               'nbdev.quarto._install_mac': ('api/quarto.html#_install_mac', 'nbdev/quarto.py'),
                               'nbdev.quarto._nbglob_docs': ('api/quarto.html#_nbglob_docs', 'nbdev/quarto.py'),
                               'nbdev.quarto._pre': ('api/quarto.html#_pre', 'nbdev/quarto.py'),
                               'nbdev.quarto._pre_docs': ('api/quarto.html#_pre_docs', 'nbdev/quarto.py'),
+                              'nbdev.quarto._readme_cands': ('api/quarto.html#_readme_cands', 'nbdev/quarto.py'),
                               'nbdev.quarto._recursive_parser': ('api/quarto.html#_recursive_parser', 'nbdev/quarto.py'),
                               'nbdev.quarto._save_cached_contributing': ('api/quarto.html#_save_cached_contributing', 'nbdev/quarto.py'),
                               'nbdev.quarto._save_cached_readme': ('api/quarto.html#_save_cached_readme', 'nbdev/quarto.py'),
@@ -336,6 +339,7 @@ d = { 'settings': { 'branch': 'main',
                                'nbdev.release.write_requirements': ('api/release.html#write_requirements', 'nbdev/release.py')},
             'nbdev.scrubmagics': {},
             'nbdev.serve': { 'nbdev.serve._is_qpy': ('api/serve.html#_is_qpy', 'nbdev/serve.py'),
+                             'nbdev.serve._keep_file': ('api/serve.html#_keep_file', 'nbdev/serve.py'),
                              'nbdev.serve._proc_file': ('api/serve.html#_proc_file', 'nbdev/serve.py'),
                              'nbdev.serve.proc_nbs': ('api/serve.html#proc_nbs', 'nbdev/serve.py')},
             'nbdev.serve_drv': {},

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/cli.py

@@ -169,18 +169,21 @@ async def nbdev_update_license(
 # %% ../nbs/api/13_cli.ipynb #412b4cd2
 @call_parse
 @delegates(nb_export, but=['procs', 'mod_maker'])
-def nb_export_cli(nbname, 
-                  debug:store_true=False, # Debug flag 
-                  **kwargs): 
+def nb_export_cli(
+    nbname,
+    debug:store_true=False, # Debug flag
+    **kwargs
+):
     "Export a single nbdev notebook to a python script."
     return nb_export(nbname=nbname, debug=debug, **kwargs)
 
 # %% ../nbs/api/13_cli.ipynb #aaa472e7
 @call_parse
-def watch_export(nbs:str=None, # Nb directory to watch for changes
-                 lib:str=None, # Export directory to write py files to
-                 force:bool=False # Ignore nbdev config if in nbdev project
-                ):
+def watch_export(
+    nbs:str=None, # Nb directory to watch for changes
+    lib:str=None, # Export directory to write py files to
+    force:bool=False # Ignore nbdev config if in nbdev project
+):
     '''Use `nb_export` on ipynb files in `nbs` directory on changes using nbdev config if available'''
     cfg = get_config() if is_nbdev() else None
     nbs = nbs or (cfg.nbs_path if cfg else '.')

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/config.py

@@ -236,7 +236,7 @@ def get_config(path=None, also_settings=False):
         nbdev = {**user, **d.get('tool', {}).get('nbdev', {})}
         return ConfigToml(nbdev, d.get('project', {}), cfg_file)
     if also_settings:
-        from fastcore.foundation import Config
+        from fastcore.xtras import Config
         cfg = Config.find('settings.ini', path)
         if cfg: return cfg
     cfg_path = Path(path or Path.cwd()).expanduser().absolute()
@@ -265,7 +265,8 @@ 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'))
+    try: p = Path(nb_path).resolve().relative_to(cfg.path('nbs_path'))
+    except ValueError: return ""
     return f"{cfg.doc_host.rstrip('/')}{cfg.doc_baseurl.rstrip('/')}/{nbpath2html(p).as_posix()}.md"
 
 # %% ../nbs/api/01_config.ipynb #163177f2

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/export.py

@@ -36,14 +36,15 @@ class ExportModuleProc:
     _exports_=_export_
 
 # %% ../nbs/api/04_export.ipynb #76717e36
-def nb_export(nbname:str,        # Filename of notebook 
-              lib_path:str=None, # Path to destination library.  If not in a nbdev project, defaults to current directory.
-              procs=None,        # Processors to use
-              name:str=None,     # Name of python script {name}.py to create.
-              mod_maker=ModuleMaker,
-              debug:bool=False,  # Debug mode
-              solo_nb:bool=False # Export single notebook outside of an nbdev project.
-             ):
+def nb_export(
+    nbname:str,        # Filename of notebook
+    lib_path:str=None, # Path to destination library.  If not in a nbdev project, defaults to current directory.
+    procs=None,        # Processors to use
+    name:str=None,     # Name of python script {name}.py to create.
+    mod_maker=ModuleMaker,
+    debug:bool=False,  # Debug mode
+    solo_nb:bool=False # Export single notebook outside of an nbdev project.
+):
     "Create module(s) from notebook"
     if lib_path is None: lib_path = get_config().lib_path if is_nbdev() else '.'
     exp = ExportModuleProc()

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/merge.py

@@ -60,11 +60,13 @@ def _merge_cells(a, b, brancha, branchb, theirs):
 
 # %% ../nbs/api/07_merge.ipynb #cc492d30
 @call_parse
-def nbdev_fix(nbname:str, # Notebook filename to fix
-               outname:str=None, # Filename of output notebook (defaults to `nbname`)
-               nobackup:bool_arg=True, # Do not backup `nbname` to `nbname`.bak if `outname` not provided
-               theirs:bool=False, # Use their outputs and metadata instead of ours
-               noprint:bool=False): # Do not print info about whether conflicts are found
+def nbdev_fix(
+    nbname:str, # Notebook filename to fix
+    outname:str=None, # Filename of output notebook (defaults to `nbname`)
+    nobackup:bool_arg=True, # Do not backup `nbname` to `nbname`.bak if `outname` not provided
+    theirs:bool=False, # Use their outputs and metadata instead of ours
+    noprint:bool=False # Do not print info about whether conflicts are found
+):
     "Create working notebook from conflicted notebook `nbname`"
     nbname = Path(nbname)
     if not nobackup and not outname: shutil.copy(nbname, nbname.with_suffix('.ipynb.bak'))

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/migrate.py

@@ -32,11 +32,12 @@ def _file_slug(fname):
     return dt + p.stem[11:]    
 
 # %% ../nbs/api/16_migrate.ipynb #689bf354
-def _replace_fm(d:dict, # dictionary you wish to conditionally change
-                k:str,  # key to check 
-                val:str,# value to check if d[k] == v
-                repl_dict:dict #dictionary that will be used as a replacement 
-               ):
+def _replace_fm(
+    d:dict, # dictionary you wish to conditionally change
+    k:str,  # key to check
+    val:str,# value to check if d[k] == v
+    repl_dict:dict #dictionary that will be used as a replacement
+):
     "replace key `k` in dict `d` if d[k] == val with `repl_dict`"
     if str(d.get(k, '')).lower().strip() == str(val.lower()).strip():
         d.pop(k)
@@ -191,8 +192,9 @@ def _migrate_workflows(path):
     wf_path = Path(path) / '.github/workflows'
     if not wf_path.exists(): return
     replacements = [
-        ('fastai/workflows/quarto-ghp@', 'fastai/workflows/quarto-ghp3@'),
-        ('fastai/workflows/nbdev-ci@', 'fastai/workflows/nbdev3-ci@'),
+        ('fastai/workflows/quarto-ghp@', 'AnswerDotAI/workflows/quarto-ghp3@'),
+        ('fastai/workflows/nbdev-ci@', 'AnswerDotAI/workflows/nbdev3-ci@'),
+        ('fastai/workflows/', 'AnswerDotAI/workflows/'),
     ]
     for f in (*wf_path.glob('*.yml'), *wf_path.glob('*.yaml')):
         txt = f.read_text()

{nbdev-3.1.0 → nbdev-3.2.1}/nbdev/processors.py

@@ -182,11 +182,15 @@ def ai_magics(cell):
         cell.source = '\n'.join(cell.source.splitlines()[1:])
 
 # %% ../nbs/api/10_processors.ipynb #5a9c8fd4
-_magics_pattern = re.compile(r'^\s*(%%|%).*', re.MULTILINE)
+_def_strip_magics = '%load_ext %autoreload %reload_ext %matplotlib %config'
 
 def clean_magics(cell):
-    "A preprocessor to remove cell magic commands"
-    if cell.cell_type == 'code': cell.source = _magics_pattern.sub('', cell.source).strip()
+    "Remove housekeeping magics: those named in the `strip_magics` config (space-separated, default `_def_strip_magics`)"
+    mm = str(get_config().get('strip_magics', _def_strip_magics)).split()
+    if not mm or cell.cell_type != 'code': return
+    pat = re.compile(rf"^\s*({'|'.join(re.escape(m) for m in mm)})\b.*", re.MULTILINE)
+    cell.source = pat.sub('', cell.source).strip()
+
 
 # %% ../nbs/api/10_processors.ipynb #93e27a52
 _re_hdr_dash = re.compile(r'^#+\s+.*\s+-\s*$', re.MULTILINE)
@@ -223,6 +227,8 @@ def _ast_contains(trees, types):
         for node in ast.walk(tree):
             if isinstance(node, types): return True
 
+def _tl_contains(trees, types): return any(isinstance(t, types) for t in trees)
+
 def _do_eval(cell):
     if cell_lang(cell) != 'python': return
     if not cell.source or 'nbdev_export'+'()' in cell.source: return
@@ -233,7 +239,7 @@ def _do_eval(cell):
     _show_dirs = {'export','exports','exporti','exec_doc'}
     if cell.directives_.keys() & _show_dirs: return True
     if _ast_contains(trees, (ast.Import, ast.ImportFrom)):
-        if _ast_contains(trees, (ast.Expr, ast.Assign)):
+        if _tl_contains(trees, (ast.Import, ast.ImportFrom)) and _tl_contains(trees, (ast.Expr, ast.Assign)):
             warn(f'Found cells containing imports and other code. See FAQ.\n---\n{cell.source}\n---\n')
         return True
     if _show_docs(trees): return True