Skip to content

Commit 834440d

Browse files
committed
Fix doc errors and add tracking message
1 parent f84b99f commit 834440d

File tree

2 files changed

+65
-61
lines changed

2 files changed

+65
-61
lines changed

docs/source/api.rst

Lines changed: 61 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ User Functions
77
--------------
88

99
.. autosummary::
10-
fsspec.available_compressions
11-
fsspec.available_protocols
12-
fsspec.filesystem
13-
fsspec.fuse.run
14-
fsspec.generic.rsync
15-
fsspec.get_filesystem_class
16-
fsspec.get_mapper
17-
fsspec.gui.FileSelector
18-
fsspec.open
19-
fsspec.open_files
20-
fsspec.open_local
10+
available_compressions
11+
available_protocols
12+
filesystem
13+
fuse.run
14+
generic.rsync
15+
get_filesystem_class
16+
get_mapper
17+
gui.FileSelector
18+
open
19+
open_files
20+
open_local
2121

2222
.. autofunction:: fsspec.available_compressions
2323
.. autofunction:: fsspec.available_protocols
@@ -36,24 +36,24 @@ Base Classes
3636
------------
3737

3838
.. autosummary::
39-
fsspec.archive.AbstractArchiveFileSystem
40-
fsspec.asyn.AsyncFileSystem
41-
fsspec.callbacks.Callback
42-
fsspec.callbacks.DotPrinterCallback
43-
fsspec.callbacks.NoOpCallback
44-
fsspec.callbacks.TqdmCallback
45-
fsspec.core.BaseCache
46-
fsspec.core.OpenFile
47-
fsspec.core.OpenFiles
48-
fsspec.core.get_fs_token_paths
49-
fsspec.core.url_to_fs
50-
fsspec.dircache.DirCache
51-
fsspec.FSMap
52-
fsspec.generic.GenericFileSystem
53-
fsspec.registry.register_implementation
54-
fsspec.spec.AbstractBufferedFile
55-
fsspec.spec.AbstractFileSystem
56-
fsspec.spec.Transaction
39+
archive.AbstractArchiveFileSystem
40+
asyn.AsyncFileSystem
41+
callbacks.Callback
42+
callbacks.DotPrinterCallback
43+
callbacks.NoOpCallback
44+
callbacks.TqdmCallback
45+
core.BaseCache
46+
core.OpenFile
47+
core.OpenFiles
48+
core.get_fs_token_paths
49+
core.url_to_fs
50+
dircache.DirCache
51+
FSMap
52+
generic.GenericFileSystem
53+
registry.register_implementation
54+
spec.AbstractBufferedFile
55+
spec.AbstractFileSystem
56+
spec.Transaction
5757

5858
.. autoclass:: fsspec.archive.AbstractArchiveFileSystem
5959
:members:
@@ -107,31 +107,31 @@ Built-in Implementations
107107
------------------------
108108

109109
.. autosummary::
110-
fsspec.implementations.arrow.ArrowFSWrapper
111-
fsspec.implementations.arrow.HadoopFileSystem
112-
fsspec.implementations.cached.CachingFileSystem
113-
fsspec.implementations.cached.SimpleCacheFileSystem
114-
fsspec.implementations.cached.WholeFileCacheFileSystem
115-
fsspec.implementations.dask.DaskWorkerFileSystem
116-
fsspec.implementations.data.DataFileSystem
117-
fsspec.implementations.dbfs.DatabricksFileSystem
118-
fsspec.implementations.dirfs.DirFileSystem
119-
fsspec.implementations.ftp.FTPFileSystem
120-
fsspec.implementations.gist.GistFileSystem
121-
fsspec.implementations.git.GitFileSystem
122-
fsspec.implementations.github.GithubFileSystem
123-
fsspec.implementations.http.HTTPFileSystem
124-
fsspec.implementations.jupyter.JupyterFileSystem
125-
fsspec.implementations.libarchive.LibArchiveFileSystem
126-
fsspec.implementations.local.LocalFileSystem
127-
fsspec.implementations.memory.MemoryFileSystem
128-
fsspec.implementations.reference.ReferenceFileSystem
129-
fsspec.implementations.reference.LazyReferenceMapper
130-
fsspec.implementations.sftp.SFTPFileSystem
131-
fsspec.implementations.smb.SMBFileSystem
132-
fsspec.implementations.tar.TarFileSystem
133-
fsspec.implementations.webhdfs.WebHDFS
134-
fsspec.implementations.zip.ZipFileSystem
110+
implementations.arrow.ArrowFSWrapper
111+
implementations.arrow.HadoopFileSystem
112+
implementations.cached.CachingFileSystem
113+
implementations.cached.SimpleCacheFileSystem
114+
implementations.cached.WholeFileCacheFileSystem
115+
implementations.dask.DaskWorkerFileSystem
116+
implementations.data.DataFileSystem
117+
implementations.dbfs.DatabricksFileSystem
118+
implementations.dirfs.DirFileSystem
119+
implementations.ftp.FTPFileSystem
120+
implementations.gist.GistFileSystem
121+
implementations.git.GitFileSystem
122+
implementations.github.GithubFileSystem
123+
implementations.http.HTTPFileSystem
124+
implementations.jupyter.JupyterFileSystem
125+
implementations.libarchive.LibArchiveFileSystem
126+
implementations.local.LocalFileSystem
127+
implementations.memory.MemoryFileSystem
128+
implementations.reference.ReferenceFileSystem
129+
implementations.reference.LazyReferenceMapper
130+
implementations.sftp.SFTPFileSystem
131+
implementations.smb.SMBFileSystem
132+
implementations.tar.TarFileSystem
133+
implementations.webhdfs.WebHDFS
134+
implementations.zip.ZipFileSystem
135135

136136
.. autoclass:: fsspec.implementations.arrow.ArrowFSWrapper
137137
:members: __init__
@@ -296,12 +296,12 @@ Read Buffering
296296
--------------
297297

298298
.. autosummary::
299-
fsspec.caching.BlockCache
300-
fsspec.caching.BytesCache
301-
fsspec.caching.MMapCache
302-
fsspec.caching.ReadAheadCache
303-
fsspec.caching.FirstChunkCache
304-
fsspec.caching.BackgroundBlockCache
299+
caching.BlockCache
300+
caching.BytesCache
301+
caching.MMapCache
302+
caching.ReadAheadCache
303+
caching.FirstChunkCache
304+
caching.BackgroundBlockCache
305305

306306
.. autoclass:: fsspec.caching.BlockCache
307307
:members:
@@ -326,7 +326,7 @@ Utilities
326326

327327
.. autosummary::
328328

329-
fsspec.utils.read_block
329+
utils.read_block
330330

331331
.. autofunction:: fsspec.utils.read_block
332332

docs/source/index.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,10 @@ The current list of known implementations can be found as follows
120120
api.rst
121121
changelog.rst
122122

123+
124+
These docs pages collect anonymous tracking data using goatcounter, and the
125+
dashboard is available to the public: https://fsspec.goatcounter.com/ .
126+
123127
.. raw:: html
124128

125129
<script data-goatcounter="https://fsspec.goatcounter.com/count"

0 commit comments

Comments
 (0)