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


def install_quarto(
    
):

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

source

install


def install(
    
):

Install Quarto and the current library

Sidebar

source

IndentDumper


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

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

source

nbdev_sidebar


def nbdev_sidebar(
    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
):

Create sidebar.yml

# nbdev_sidebar(printit=True, force=True)

Render docs

source

refresh_quarto_yml


def refresh_quarto_yml(
    
):

Generate _quarto.yml from settings.ini.

source

nbdev_proc_nbs


def nbdev_proc_nbs(
    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
):

Process notebooks in path for docs rendering

source

nbdev_readme


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

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

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

source

nbdev_contributing


def nbdev_contributing(
    path:str=None, # Path to notebooks
    chk_time:bool=False, # Only build if out-of-date
):

Create CONTRIBUTING.md from contributing_nb (defaults to ‘contributing.ipynb’ if present). Skips if the file doesn’t exist.

source

nbdev_docs


def nbdev_docs(
    path:str=None, # Path to notebooks
    n_workers:int=4, # Number of workers
):

Create Quarto docs and README.md

source

prepare


def prepare(
    
):

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

Preview

source

fs_watchdog


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

File system watchdog dispatching to func

source

nbdev_preview


def nbdev_preview(
    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
):

Preview docs locally