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 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__ diff --git a/docs/source/index.rst b/docs/source/index.rst index a36510f1b..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 -``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::