sphinx.util.fileutil

module documentation

(source)

File utility functions for Sphinx.

Function	`copy_asset`	Copy asset files to destination recursively.
Function	`copy_asset_file`	Copy an asset file to destination.

def copy_asset(source, destination, excluded=(lambda path: False), context=None, renderer=None, onerror=None): (source) ¶

Copy asset files to destination recursively. On copying, it expands the template variables if context argument is given and the asset is a template file. :param source: The path to source file or directory :param destination: The path to destination directory :param excluded: The matcher to determine the given path should be copied or not :param context: The template variables. If not given, template files are simply copied :param renderer: The template engine. If not given, SphinxRenderer is used by default :param onerror: The error handler.

Parameters
source:`str`	Undocumented
destination:`str`	Undocumented
excluded:`PathMatcher`	Undocumented
context:`dict\|None`	Undocumented
renderer:`BaseRenderer\|None`	Undocumented
onerror:`Callable[[str, Exception], None]\|None`	Undocumented

def copy_asset_file(source, destination, context=None, renderer=None): (source) ¶

Copy an asset file to destination. On copying, it expands the template variables if context argument is given and the asset is a template file. :param source: The path to source file :param destination: The path to destination file or directory :param context: The template variables. If not given, template files are simply copied :param renderer: The template engine. If not given, SphinxRenderer is used by default

Parameters
source:`str`	Undocumented
destination:`str`	Undocumented
context:`dict\|None`	Undocumented
renderer:`BaseRenderer\|None`	Undocumented