quarto

从 nbdev 安装和使用 Quarto

关于 Quarto 如何在此处融入的有用背景信息：https://nbdev.fastai.net.cn/explanations/docs.html

安装

install_quarto

 install_quarto ()

在 macOS 或 Linux 上安装最新 Quarto，打印 Windows 安装说明

source

install

 install ()

安装 Quarto 和当前库

侧边栏

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)

初始化 self。请参阅 help(type(self)) 获取准确的签名信息。

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='^[_.]')

创建 sidebar.yml

	类型	默认值	详情
path	str	None	Notebooks 路径
printit	bool	False	打印 YAML 以进行调试
force	bool	False	即使 settings.ini 中的 custom_sidebar=False 也创建侧边栏
skip_folder_re	str	(?:^[_.]\|^www$)	跳过匹配正则表达式的文件夹
file_glob	str	None	仅包含匹配 glob 表达式的文件
file_re	str	.(?:ipynb\|qmd\|html)$	仅包含匹配正则表达式的文件
symlinks	bool	False	跟随符号链接？
folder_re	str	None	仅进入匹配正则表达式的文件夹
skip_file_glob	str	None	跳过匹配 glob 表达式的文件
skip_file_re	str	^[_.]	跳过匹配正则表达式的文件

# nbdev_sidebar(printit=True, force=True)

渲染文档

source

refresh_quarto_yml

 refresh_quarto_yml ()

从 settings.ini 生成 _quarto.yml。

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='^[_.]')

处理 path 中的 notebooks 以进行文档渲染

	类型	默认值	详情
path	str		Notebooks 路径
n_workers	int	4	工作进程数
force	bool	False	忽略缓存并构建所有
file_glob	str		仅包含匹配 glob 表达式的文件
file_re	str		仅包含匹配 glob 表达式的文件
symlinks	bool	False	跟随符号链接？
folder_re	str	None	仅进入匹配正则表达式的文件夹
skip_file_glob	str	None	跳过匹配 glob 表达式的文件
skip_file_re	str	^[_.]	跳过匹配正则表达式的文件
skip_folder_re	str	^[_.]	跳过匹配正则表达式的文件夹

source

nbdev_readme

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

从 readme_nb (默认为 index.ipynb) 创建 README.md

	类型	默认值	详情
path	str	None	Notebooks 路径
chk_time	bool	False	仅在文件过时时构建

nbdev_readme 调用“quarto render”，这在 Quarto 指南此处有所解释。

source

nbdev_contributing

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

从 contributing_nb (如果存在，默认为 ‘contributing.ipynb’) 创建 CONTRIBUTING.md。如果文件不存在则跳过。

	类型	默认值	详情
path	str	None	Notebooks 路径
chk_time	bool	False	仅在文件过时时构建

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='^[_.]')

创建 Quarto 文档和 README.md

	类型	默认值	详情
path	str	None	Notebooks 路径
n_workers	int	4	工作进程数
file_glob	str	None	仅包含匹配 glob 表达式的文件
file_re	str	.(?:ipynb\|qmd\|html)$	仅包含匹配正则表达式的文件
symlinks	bool	False	跟随符号链接？
folder_re	str	None	仅进入匹配正则表达式的文件夹
skip_file_glob	str	None	跳过匹配 glob 表达式的文件
skip_file_re	str	^[_.]	跳过匹配正则表达式的文件
skip_folder_re	str	^[_.]	跳过匹配正则表达式的文件夹

source

prepare

 prepare ()

导出、测试和清理 notebooks，并在需要时渲染 README

预览

source

fs_watchdog

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

将文件系统看门狗分派到 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='^[_.]')

本地预览文档

	类型	默认值	详情
path	str	None	Notebooks 路径
port	int	None	运行预览的端口
host	str	None	运行预览的主机
no_browser	bool	False	不打开浏览器
n_workers	int	4	工作进程数
file_glob	str	None	仅包含匹配 glob 表达式的文件
file_re	str	.(?:ipynb\|qmd\|html)$	仅包含匹配正则表达式的文件
symlinks	bool	False	跟随符号链接？
folder_re	str	None	仅进入匹配正则表达式的文件夹
skip_file_glob	str	None	跳过匹配 glob 表达式的文件
skip_file_re	str	^[_.]	跳过匹配正则表达式的文件
skip_folder_re	str	^[_.]	跳过匹配正则表达式的文件夹