git

git driver clones a given repository into a target folder.

URL must be given by source parameter.

collections = {
    'my_files': {
        'driver': 'git',
        'source': 'https://github.com/useblocks/sphinx_dummy.git',
    }
}

Sphinx-Collections will clone the given repository into _collections/my_files/.

Hint

Git binary must be installed on the system, so that the used Python library gitpython can use it.

Clean up behavior

During clean up the local repository clone gets deleted.