sphinx_gallery.downloads

可下载项目实用工具。

函数

sphinx_gallery.downloads.generate_zipfiles(gallery_dir, src_dir, gallery_conf)

收集可下载的源文件并创建它们的 zip 文件。

收集 gallery_dir 中所有源文件和 Jupyter 笔记本。

参数:

• gallery_dir (str) – 要收集可下载源文件的画廊路径

• src_dir (str) – 构建源目录。需要使 reST 路径相对。

• gallery_conf (dict[str, Any]) – Sphinx-Gallery 配置字典

返回值:

download_rst – 包含指向生成的文件的下载按钮的重新构造文本

返回类型:

str

sphinx_gallery.downloads.list_downloadable_sources(target_dir, extensions=('.py',))

返回 target_dir 中源文件的列表。

参数:

• target_dir (str) – 源文件所在的目录路径

• extensions (tuple[str]) – 要包含的文件扩展名的元组

返回值:

target_dir 中所有源文件的路径列表，以指定扩展名之一结尾

返回类型:

list

sphinx_gallery.downloads.python_zip(file_list, gallery_path, extension='.py')

将 file_list 中的所有文件存储到一个 zip 文件中。

参数:

• file_list (list) – 包含要包含在 zip 文件中的所有文件名的列表

• gallery_path (str) – zip 文件存储位置的路径

• extension (str | None) – 为了处理纯源文件和 jupyter 笔记本的下载，如果此值不是 None，则在生成 zip 文件时会删除文件列表中文件的扩展名并用此变量的值替换。

返回值:

zipname – zip 文件名，写成 target_dir_python.zip、target_dir_jupyter.zip 或 target_dir.zip，具体取决于扩展名

返回类型:

str