DOC: hyperlink registry

[raybellwaves]

I test locally later.

You can add a rtd build check using the site (click button at botton of image)

[raybellwaves]

couldn't get the hyperlink to work. I belive because https://filesystem-spec.readthedocs.io/en/latest/_modules/fsspec/registry.html isn't part of the API.

[martindurant]

Feel free to add it. The registry could probably do with more work to include searching for entrypoints anyway.

[raybellwaves]

bit unsure where to put it. Dropped it in Built-in Implementations but not sure if autofunction is appropriate. The hyperlink works but it's not very useful. Ideally want to show the dict when you click on the hyperlink from the home page

"file": {"class": "fsspec.implementations.local.LocalFileSystem"},
    "memory": {"class": "fsspec.implementations.memory.MemoryFileSystem"},
    "dropbox": {
        "class": "dropboxdrivefs.DropboxDriveFileSystem",
        "err": (
            'DropboxFileSystem requires "dropboxdrivefs",'
            '"requests" and "dropbox" to be installed'
        ),
    },
...

[martindurant]

A couple of possible solutions for directly including the dictionary: https://stackoverflow.com/questions/27875455/displaying-dictionary-data-in-sphinx-documentation/29789910

[martindurant]

(ping)

[martindurant]

Actually, on second reading, this is wrong. fsspec.registry is indeed the set of classes that have been used so far: the values are python class objects. known_implementations is a dictionary where the values are dictionaries of import details, location of the class and reasonable error messages - it serves as the source of the classes for registry via fsspec.get_filesystem_class, but you could edit either one at runtime.

[martindurant]

Sorry, this seems to have got lost. Still interested?