sphinx_gallery.downloads

ダウンロード可能なアイテムのためのユーティリティ。

関数

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

ダウンロード可能なソースを収集し、それらのzipファイルを生成します。

gallery_dir内のすべてのソースファイルとJupyter Notebookを収集します。

パラメーター：

• gallery_dir (str) – ダウンロード可能なソースを収集するギャラリーのパス

• src_dir (str) – ビルドソースディレクトリ。reSTパスの相対化に必要なものです。

• gallery_conf (dict[str, Any]) – Sphinx-Gallery設定辞書

戻り値：

download_rst – 生成されたファイルへのダウンロードボタンを含めるためのreStructuredText

戻り値の型：

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) – zipfileが保存される場所へのパス

• extension (str | None) – 通常のソースファイルとJupyter Notebookのダウンロードに対応するため、この値がNoneでない場合、file_list内のファイルのファイル拡張子が削除され、zipファイルの生成時にこの変数の値に置き換えられます。

戻り値：

zipname – zipファイル名。extensionに応じてtarget_dir_python.zip、target_dir_jupyter.zip、またはtarget_dir.zipとして記述されます。

戻り値の型：

str