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 中所有原始碼檔案的路徑列表

返回類型:

列表

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 檔案時，將從 file_list 中的檔案中移除檔案副檔名，並替換為此變數的值

返回:

zipname – zip 檔案名稱，根據副檔名寫成 target_dir_python.zip、target_dir_jupyter.zip 或 target_dir.zip

返回類型:

str