mdoc

Author: jph00

nbdev/config.py

@@ -1,10 +1,17 @@
+"""Read and write nbdev's `settings.ini` file.
+`get_config` is the main function for reading settings."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/09_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/09_API/01_config.ipynb 3
+# %% ../nbs/09_API/01_config.ipynb 2
+_doc_ = """Read and write nbdev's `settings.ini` file.
+`get_config` is the main function for reading settings."""
+
+# %% ../nbs/09_API/01_config.ipynb 4
 from datetime import datetime
 from fastcore.utils import *
 from fastcore.meta import *
@@ -17,16 +24,16 @@
 from execnb.nbio import read_nb,NbCell
 from urllib.error import HTTPError
 
-# %% ../nbs/09_API/01_config.ipynb 8
+# %% ../nbs/09_API/01_config.ipynb 9
 _nbdev_home_dir = 'nbdev' # sub-directory of xdg base dir
 _nbdev_cfg_name = 'settings.ini'
 
-# %% ../nbs/09_API/01_config.ipynb 9
+# %% ../nbs/09_API/01_config.ipynb 10
 def _git_repo():
     try: return repo_details(run('git config --get remote.origin.url'))[1]
     except OSError: return
 
-# %% ../nbs/09_API/01_config.ipynb 11
+# %% ../nbs/09_API/01_config.ipynb 12
 def _apply_defaults(
     cfg,
     lib_name='%(repo)s', # Package name
@@ -70,7 +77,7 @@ def _apply_defaults(
         cfg[k] = v
     return cfg
 
-# %% ../nbs/09_API/01_config.ipynb 12
+# %% ../nbs/09_API/01_config.ipynb 13
 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'))
@@ -86,7 +93,7 @@ def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):
 
     return r.default_branch, default_kw if not r.topics else ' '.join(r.topics), r.description
 
-# %% ../nbs/09_API/01_config.ipynb 14
+# %% ../nbs/09_API/01_config.ipynb 15
 def _fetch_from_git(raise_err=False):
     "Get information for settings.ini from the user."
     res={}
@@ -102,7 +109,7 @@ def _fetch_from_git(raise_err=False):
     else: res['lib_name'] = res['repo'].replace('-','_')
     return res
 
-# %% ../nbs/09_API/01_config.ipynb 16
+# %% ../nbs/09_API/01_config.ipynb 17
 def _prompt_user(cfg, inferred):
     "Let user input values not in `cfg` or `inferred`."
     res = cfg.copy()
@@ -116,7 +123,7 @@ def _prompt_user(cfg, inferred):
                 print(msg+res[k]+' # Automatically inferred from git')
     return res
 
-# %% ../nbs/09_API/01_config.ipynb 18
+# %% ../nbs/09_API/01_config.ipynb 19
 def _cfg2txt(cfg, head, sections, tail=''):
     "Render `cfg` with commented sections."
     nm = cfg.d.name
@@ -128,7 +135,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
     res += tail
     return res.strip()
 
-# %% ../nbs/09_API/01_config.ipynb 20
+# %% ../nbs/09_API/01_config.ipynb 21
 _nbdev_cfg_head = '''# All sections below are required unless otherwise specified.
 # See https://github.com/fastai/nbdev/blob/master/settings.ini for examples.
 
@@ -143,7 +150,7 @@ def _cfg2txt(cfg, head, sections, tail=''):
 # console_scripts =
 '''
 
-# %% ../nbs/09_API/01_config.ipynb 21
+# %% ../nbs/09_API/01_config.ipynb 22
 @call_parse
 @delegates(_apply_defaults, but='cfg')
 def nbdev_create_config(
@@ -168,19 +175,19 @@ def nbdev_create_config(
     cfg_fn = Path(path)/cfg_name
     print(f'{cfg_fn} created.')
 
-# %% ../nbs/09_API/01_config.ipynb 24
+# %% ../nbs/09_API/01_config.ipynb 25
 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/09_API/01_config.ipynb 26
+# %% ../nbs/09_API/01_config.ipynb 27
 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/09_API/01_config.ipynb 27
+# %% ../nbs/09_API/01_config.ipynb 28
 _types = dict(custom_sidebar=bool, nbs_path=Path, lib_path=Path, doc_path=Path, recursive=bool, 
     black_formatting=bool, jupyter_hooks=bool, clean_ids=bool, custom_quarto_yml=bool)
 
@@ -192,22 +199,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/09_API/01_config.ipynb 42
+# %% ../nbs/09_API/01_config.ipynb 43
 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/09_API/01_config.ipynb 44
+# %% ../nbs/09_API/01_config.ipynb 45
 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/09_API/01_config.ipynb 45
+# %% ../nbs/09_API/01_config.ipynb 46
 def show_src(src, lang='python'): return Markdown(f'```{lang}\n{src}\n```')
 
-# %% ../nbs/09_API/01_config.ipynb 48
+# %% ../nbs/09_API/01_config.ipynb 49
 _re_version = re.compile('^__version__\s*=.*$', re.MULTILINE)
 _init = '__init__.py'
 
@@ -236,13 +243,13 @@ def add_init(path=None):
         if _has_py(fs) or any(filter(_has_py, subds)) and not (r/_init).exists(): (r/_init).touch()
     update_version(path)
 
-# %% ../nbs/09_API/01_config.ipynb 51
+# %% ../nbs/09_API/01_config.ipynb 52
 def write_cells(cells, hdr, file, offset=0):
     "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(): file.write(f'\n\n{hdr} {cell.idx_+offset}\n{cell.source}')
 
-# %% ../nbs/09_API/01_config.ipynb 52
+# %% ../nbs/09_API/01_config.ipynb 53
 def _basic_export_nb(fname, name, dest=None):
     "Basic exporter to bootstrap nbdev."
     if dest is None: dest = get_config().lib_path

nbs/09_API/01_config.ipynb

@@ -19,6 +19,17 @@
     "#|default_exp config"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "#|export\n",
+    "_doc_ = \"\"\"Read and write nbdev's `settings.ini` file.\n",
+    "`get_config` is the main function for reading settings.\"\"\""
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,