Bug when using the symlink driver

[n-burger]

Thanks for the great work. I think this extension is very helpful! Unfortunately, the symlink driver is not usable at the moment.

The function Collections:init (collections.py, line 101), creates a directory for every collection. Subsequently, the symlink driver fails to create a symlink, because a directory under the same name exists already:

Executing collections ...
  external_folder: (SymlinkDriver) Creating symlink...
Traceback (most recent call last):
  File "***/sphinxcontrib/collections/drivers/symlink.py", line 54, in run
    os.symlink(source, target)
FileExistsError: [Errno 17] File exists: ***/doc/external_folder' -> '***/doc/_collections/external_folder'

Configuration used:

collections = {
    "external_folder": {
        "driver": "symlink",
        "source": str(PROJECT_BASE / "external_folder"),
        "target": "external_folder",
    },
}

[n-burger]

Adding the following lines to the SymlinkDriver:run() fixes the issue:

        if os.path.exists(target):
            self.info("Removing already existing directory...")
            os.unlink(target)

[jgarte]

@n-burger Hi, can you make a PR for that?

[GuillaumeBroggi]

A quick fix that does not require patching the extension is to ensure the /doc/_collections directory already exists before building the docs, e.g., by adding it as an empty directory, see bessagroup/graphorge@03686a9