symlink¶
Creates a symlink (symbolic link) from target
to source
.
target
must be a folder inside your documentation project.
Please note, config option source
is used as the name where the symlink shows to,
as this is our data source for additional sphinx files.
And target
is the path where the symlink starts, because this defines the place
where the extra sphinx files shall be stored.
If executed on Windows 10, special privileges may be needed for creating symlinks. Please see os.symlink() details for constraints.
This symlink driver can deal with links to folders and files.
collections = {
'my_files: {
'driver': 'symlink',
'source': '../extra_files/',
'target': 'my_data/'
}
}
}
Clean up behavior¶
During clean up the symlink gets unlinked/removed.