cli

CLI commands

nbdev_ghp_deploy

 nbdev_ghp_deploy ()

Deploy docs in doc_path from settings.ini to GitHub Pages


nbdev_sidebar

 nbdev_sidebar (path:str=None, symlinks:bool=False, file_glob:str=None,
                file_re:str='\\.(?:ipynb|qmd|html)$', folder_re:str=None,
                skip_file_glob:str=None, skip_file_re:str='^[_.]',
                skip_folder_re:str='(?:^[_.]|^www$)', printit:bool=False,
                force:bool=False, returnit:bool=False)

Create sidebar.yml

Type Default Details
path str None Path to notebooks
symlinks bool False Follow symlinks?
file_glob str None Only include files matching glob
file_re str .(?:ipynb|qmd|html)$ Only include files matching regex
folder_re str None Only enter folders matching regex
skip_file_glob str None Skip files matching glob
skip_file_re str 1 Skip files matching regex
skip_folder_re str (?:[_.]|www$) Skip folders matching regex
printit bool False Print YAML for debugging
force bool False Create sidebar even if settings.ini custom_sidebar=False
returnit bool False Return list of files found
# nbdev_sidebar(printit=True, force=True)

FilterDefaults

 FilterDefaults ()

Override FilterDefaults to change which notebook processors are used


nbdev_filter

 nbdev_filter (nb_txt:str=None, fname:str=None)

A notebook filter for Quarto

Type Default Details
nb_txt str None Notebook text (uses stdin if not provided)
fname str None Notebook to read (uses nb_txt if not provided)

nbdev_bump_version

 nbdev_bump_version (part:int=2, unbump:bool=False)

Increment version in settings.ini by one

Type Default Details
part int 2 Part of version to bump
unbump bool False Reduce version instead of increasing it

bump_version

 bump_version (version, part=2, unbump=False)

update_version

 update_version ()

Add or update __version__ in the main __init__.py of the library


extract_tgz

 extract_tgz (url, dest='.')

prompt_user

 prompt_user (cfg, inferred)

Let user input values not in cfg or inferred.


refresh_quarto_yml

 refresh_quarto_yml ()

Generate _quarto.yml from settings.ini.


nbdev_new

 nbdev_new (lib_name:str=None)

Create a new project from the current git repo

Type Default Details
lib_name str None Package name (default: inferred from repo name)

Quarto


nbdev_readme

 nbdev_readme (path:str=None, doc_path:str=None)

Render README.md from index.ipynb

Type Default Details
path str None Path to notebooks
doc_path str None Path to output docs

nbdev_quarto

 nbdev_quarto (path:str=None, doc_path:str=None, symlinks:bool=False,
               file_re:str='\\.(?:ipynb|qmd|html)$', folder_re:str=None,
               skip_file_glob:str=None, skip_file_re:str=None,
               preview:bool=False)

Create Quarto docs and README.md

Type Default Details
path str None Path to notebooks
doc_path str None Path to output docs
symlinks bool False Follow symlinks?
file_re str .(?:ipynb|qmd|html)$ Only include files matching regex
folder_re str None Only enter folders matching regex
skip_file_glob str None Skip files matching glob
skip_file_re str None Skip files matching regex
preview bool False Preview the site instead of building it

Footnotes

  1. _.↩︎