quarto

Install and interact with Quarto from nbdev

Install


source

install_quarto

 install_quarto ()

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


source

install

 install ()

Install Quarto and the current library

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=2, 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 2 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
# nbdev_proc_nbs.__wrapped__()

source

nbdev_readme

 nbdev_readme (path:str=None, chk_time:bool=False)
Type Default Details
path str None Path to notebooks
chk_time bool False Only build if out of date

source

nbdev_docs

 nbdev_docs (path:str=None, n_workers:int=2, 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 2 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,
                n_workers:int=2, 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
n_workers int 2 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