From 359a23bf2faa3d4548f50585035b0c83d436acfe Mon Sep 17 00:00:00 2001 From: Ray Bell Date: Thu, 8 Oct 2020 07:57:07 -0400 Subject: [PATCH 1/4] DOC: hyperlink registry --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index a36510f1b..0ff401829 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -55,7 +55,7 @@ The current list of known implementations can be found as follows known_implementations These are only imported on request, which may fail if a required dependency is missing. The dictionary -``fsspec.registry`` contains all imported implementations, and can be mutated by user code, if necessary. +:py:class:`fsspec.registry` contains all imported implementations, and can be mutated by user code, if necessary. .. toctree:: From b0b11def0499eba3eef20a1ff6479a0ae02bc81b Mon Sep 17 00:00:00 2001 From: Ray Bell Date: Thu, 8 Oct 2020 15:11:36 -0400 Subject: [PATCH 2/4] add sphinx_rtd_theme --- docs/environment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/environment.yml b/docs/environment.yml index 28ec3cb11..2559f9466 100644 --- a/docs/environment.yml +++ b/docs/environment.yml @@ -6,3 +6,4 @@ dependencies: - paramiko - requests - numpydoc + - sphinx_rtd_theme From ad525d2741ff22bd0a6e5af9ff325349f499942e Mon Sep 17 00:00:00 2001 From: Ray Bell Date: Thu, 8 Oct 2020 15:29:50 -0400 Subject: [PATCH 3/4] DOC: add known_implementations --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 0ff401829..2baeeadf5 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -55,7 +55,7 @@ The current list of known implementations can be found as follows known_implementations These are only imported on request, which may fail if a required dependency is missing. The dictionary -:py:class:`fsspec.registry` contains all imported implementations, and can be mutated by user code, if necessary. +:py:class:`fsspec.registry.known_implementations` contains all imported implementations, and can be mutated by user code, if necessary. .. toctree:: From 640b41cb080b0f5f2e8e45f02a93587d31b53491 Mon Sep 17 00:00:00 2001 From: Ray Bell Date: Thu, 8 Oct 2020 21:03:28 -0400 Subject: [PATCH 4/4] add fsspec.registry.known_implementations --- docs/source/api.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/api.rst b/docs/source/api.rst index 4cac31fa2..f2a7109c8 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -81,6 +81,7 @@ Built-in Implementations ------------------------ .. autosummary:: + fsspec.registry.known_implementations fsspec.implementations.ftp.FTPFileSystem fsspec.implementations.hdfs.PyArrowHDFS fsspec.implementations.dask.DaskWorkerFileSystem @@ -98,6 +99,8 @@ Built-in Implementations fsspec.implementations.git.GitFileSystem fsspec.implementations.smb.SMBFileSystem fsspec.implementations.jupyter.JupyterFileSystem + +.. autofunction:: fsspec.registry.known_implementations .. autoclass:: fsspec.implementations.ftp.FTPFileSystem :members: __init__