Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

DOC: hyperlink registry #442

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

DOC: hyperlink registry #442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
359a23b
DOC: hyperlink registry
raybellwaves Oct 8, 2020
b0b11de
add sphinx_rtd_theme
raybellwaves Oct 8, 2020
ad525d2
DOC: add known_implementations
raybellwaves Oct 8, 2020
640b41c
add fsspec.registry.known_implementations
raybellwaves Oct 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/environment.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ dependencies:
- paramiko
- requests
- numpydoc
- sphinx_rtd_theme
3 changes: 3 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ Built-in Implementations
------------------------

.. autosummary::
fsspec.registry.known_implementations
fsspec.implementations.ftp.FTPFileSystem
fsspec.implementations.hdfs.PyArrowHDFS
fsspec.implementations.dask.DaskWorkerFileSystem
Expand All @@ -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__
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.



.. toctree::
Expand Down