cli

CLI commands

nbprocess_ghp_deploy

 nbprocess_ghp_deploy ()

Deploy docs in doc_path from settings.ini to GitHub Pages

from fastcore.all import *
l = L([1,2,4])

nbprocess_sidebar

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

	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	md
folder_re	str	None	Only enter folders matching regex
skip_file_glob	str	None	Skip files matching glob
skip_file_re	str	¹	Skip files matching regex
skip_folder_re	str	(?:²	^www$)
printit	bool	False	Print YAML for debugging
returnit	bool	False	Return list of files found

FilterDefaults

 FilterDefaults ()

Override FilterDefaults to change which notebook processors are used

nbprocess_filter

 nbprocess_filter (nb_txt:str=None)

A notebook filter for quarto

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

nbprocess_bump_version

 nbprocess_bump_version (part:int=2)

Increment version in settings.py by one

	Type	Default	Details
part	int	2	Part of version to bump

bump_version

 bump_version (version, part=2)

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 (**kwargs)

refresh_quarto_yml

 refresh_quarto_yml ()

Generate _quarto.yml from settings.ini.

nbprocess_new

 nbprocess_new ()

Create a new project from the current git repo

Quarto

nbprocess_quarto

 nbprocess_quarto (path:str=None, doc_path:str=None, symlinks:bool=False,
                   file_re:str='\\.(?:ipynb|md|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	md
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

_.↩︎
_.↩︎