quarto

Install and interact with Quarto from nbdev

Helpful background on how Quarto fits in here: https://nbdev.fast.ai/explanations/docs.html

Install

install_quarto

 install_quarto ()

Install latest Quarto on macOS or Linux, prints instructions for Windows

source

install

 install ()

Install Quarto and the current library

Sidebar

source

IndentDumper

 IndentDumper (stream, default_style=None, default_flow_style=False,
               canonical=None, indent=None, width=None,
               allow_unicode=None, line_break=None, encoding=None,
               explicit_start=None, explicit_end=None, version=None,
               tags=None, sort_keys=True)

Initialize self. See help(type(self)) for accurate signature.

source

nbdev_sidebar

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

Create sidebar.yml

	Type	Default	Details
path	str	None	Path to notebooks
printit	bool	False	Print YAML for debugging
force	bool	False	Create sidebar even if settings.ini custom_sidebar=False
skip_folder_re	str	(?:^[_.]\|^www$)	Skip folders matching regex
file_glob	str	None	Only include files matching glob
file_re	str	.(?:ipynb\|qmd\|html)$	Only include files matching regex
symlinks	bool	False	Follow symlinks?
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

# nbdev_sidebar(printit=True, force=True)

Render docs

source

refresh_quarto_yml

 refresh_quarto_yml ()

Generate _quarto.yml from settings.ini.

source

nbdev_proc_nbs

 nbdev_proc_nbs (path:str='', n_workers:int=4, force:bool=False,
                 file_glob:str='', file_re:str='', symlinks:bool=False,
                 folder_re:str=None, skip_file_glob:str=None,
                 skip_file_re:str='^[_.]', skip_folder_re:str='^[_.]')

Process notebooks in path for docs rendering

	Type	Default	Details
path	str		Path to notebooks
n_workers	int	4	Number of workers
force	bool	False	Ignore cache and build all
file_glob	str		Only include files matching glob
file_re	str		Only include files matching glob
symlinks	bool	False	Follow symlinks?
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	^[_.]	Skip folders matching regex

source

nbdev_readme

 nbdev_readme (path:str=None, chk_time:bool=False)

Create README.md from readme_nb (index.ipynb by default)

	Type	Default	Details
path	str	None	Path to notebooks
chk_time	bool	False	Only build if out of date

nbdev_readme calls “quarto render,” which is explained in the Quarto guide here.

source

nbdev_docs

 nbdev_docs (path:str=None, n_workers:int=4, file_glob:str=None,
             file_re:str='\\.(?:ipynb|qmd|html)$', symlinks:bool=False,
             folder_re:str=None, skip_file_glob:str=None,
             skip_file_re:str='^[_.]', skip_folder_re:str='^[_.]')

Create Quarto docs and README.md

	Type	Default	Details
path	str	None	Path to notebooks
n_workers	int	4	Number of workers
file_glob	str	None	Only include files matching glob
file_re	str	.(?:ipynb\|qmd\|html)$	Only include files matching regex
symlinks	bool	False	Follow symlinks?
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	^[_.]	Skip folders matching regex

source

prepare

 prepare ()

Export, test, and clean notebooks, and render README if needed

Preview

source

fs_watchdog

 fs_watchdog (func, path, recursive:bool=True)

File system watchdog dispatching to func

source

nbdev_preview

 nbdev_preview (path:str=None, port:int=None, host:str=None,
                no_browser:bool=False, n_workers:int=4,
                file_glob:str=None, file_re:str='\\.(?:ipynb|qmd|html)$',
                symlinks:bool=False, folder_re:str=None,
                skip_file_glob:str=None, skip_file_re:str='^[_.]',
                skip_folder_re:str='^[_.]')

Preview docs locally

	Type	Default	Details
path	str	None	Path to notebooks
port	int	None	The port on which to run preview
host	str	None	The host on which to run preview
no_browser	bool	False	Do not open a browser
n_workers	int	4	Number of workers
file_glob	str	None	Only include files matching glob
file_re	str	.(?:ipynb\|qmd\|html)$	Only include files matching regex
symlinks	bool	False	Follow symlinks?
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	^[_.]	Skip folders matching regex