sphinx_gallery.downloads

Utilities for downloadable items

Functions

sphinx_gallery.downloads.generate_zipfiles(gallery_dir, src_dir)[source]

Collects all Python source files and Jupyter notebooks in gallery_dir and makes zipfiles of them

Parameters
  • gallery_dir (str) – path of the gallery to collect downloadable sources

  • src_dir (str) – The build source directory. Needed to make the RST paths relative.

Returns

download_rst – RestructuredText to include download buttons to the generated files

Return type

str

sphinx_gallery.downloads.list_downloadable_sources(target_dir)[source]

Returns a list of python source files is target_dir

Parameters

target_dir (str) – path to the directory where python source file are

Returns

list of paths to all Python source files in target_dir

Return type

list

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

Stores all files in file_list into an zip file

Parameters
  • file_list (list) – Holds all the file names to be included in zip file

  • gallery_path (str) – path to where the zipfile is stored

  • extension (str) – ‘.py’ or ‘.ipynb’ In order to deal with downloads of python sources and jupyter notebooks the file extension from files in file_list will be removed and replace with the value of this variable while generating the zip file

Returns

zipname – zip file name, written as target_dir_{python,jupyter}.zip depending on the extension

Return type

str