copy_folder

Copies a folder tree from source into your documentation project:

collections = {
    'my_files': {
        'driver': 'copy_folder',
        'source': '../../extra_files/',
        'target': 'my_data/',
        'ignore': ['*.dat', '.exe'],
    }
}

Options

ignore

List of file matches, which shall get ignored from copy.

This variable is internally given to shutil.ignore_patterns. So it must follow its syntax rules.

Clean up behavior

During clean up the target folder gets deleted.