Fix reference to MMapCache in CachingFileSystem docstring (#935)

* Fix reference to MMapCache in CachingFileSystem docstring

* Fix line length of cached.py

* Fix unnecessary highlight reference

* Add numpydoc_show_class_members=False to sphinx conf.py

* Fix docstring formatting for ReferenceFileSystem

* Add smbclient to sphinx docs mocked packages

* Fix underline length issue in docstring

* Fix incorrect HadoopFileSystem autodoc reference

Author: djhoese

docs/source/api.rst

@@ -138,7 +138,7 @@ Built-in Implementations
 .. autoclass:: fsspec.implementations.arrow.ArrowFSWrapper
    :members: __init__
 
-.. autoclass:: fsspec.implementations.hdfs.HadoopFileSystem
+.. autoclass:: fsspec.implementations.arrow.HadoopFileSystem
    :members: __init__
 
 .. autoclass:: fsspec.implementations.dask.DaskWorkerFileSystem

docs/source/conf.py

@@ -39,6 +39,8 @@
     "numpydoc",
 ]
 
+numpydoc_show_class_members = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
@@ -99,6 +101,7 @@
     "pygit2",
     "requests",
     "smbprotocol",
+    "smbclient",
 ]
 
 

docs/source/intro.rst

@@ -69,7 +69,7 @@ Other similar work
 ------------------
 
 It might have been conceivable to reuse code in ``pyfilesystems``, which has an established interface and several
-implementations of its own. However, it supports none of the :ref:`highlight`, critical to
+implementations of its own. However, it supports none of the **critical** features for
 cloud and parallel access, and would not be easy to
 coerce. Following on the success of ``s3fs`` and ``gcsfs``, and their use within Dask, it seemed best to
 have an interface as close to those as possible. See a

fsspec/caching.py

@@ -229,7 +229,7 @@ def cache_info(self):
         The statistics on the block cache.
 
         Returns
-        ----------
+        -------
         NamedTuple
             Returned directly from the LRU Cache used internally.
         """

fsspec/implementations/cached.py

@@ -26,7 +26,8 @@ class CachingFileSystem(AbstractFileSystem):
     directory with random hashes for the filenames. If no directory is given,
     a temporary one is used, which should be cleaned up by the OS after the
     process ends. The files themselves are sparse (as implemented in
-    :class:`~fsspec.core.MMapCache`), so only the data which is accessed takes up space.
+    :class:`~fsspec.caching.MMapCache`), so only the data which is accessed
+    takes up space.
 
     Restrictions:
 

fsspec/implementations/reference.py

@@ -109,6 +109,7 @@ def __init__(
                 - a dict of protocol:filesystem, where each value is either a filesystem
                   instance, or a dict of kwargs that can be used to create in
                   instance for the given protocol
+
             If this is given, remote_options and remote_protocol are ignored.
         template_overrides : dict
             Swap out any templates in the references file with these - useful for