fix: readthedocs build

docs/source/api.rst

@@ -3,7 +3,6 @@ API documentation
 
 .. autosummary::
    :toctree: _autosummary
-   :recursive:
 
    torchcache.torchcache
    torchcache.torchcache._TorchCache

docs/source/conf.py

@@ -5,7 +5,8 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath(".."))  # Source code dir relative to this file
+# Source code dir relative to this file
+sys.path.insert(0, os.path.abspath(".." + os.sep + ".."))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -26,7 +27,11 @@
     "sphinx.ext.autosummary",
     "numpydoc",
 ]
-autosummary_generate = True  # Turn on sphinx.ext.autosummary
+if os.environ.get("READTHEDOCS") == "True":
+    autosummary_generate = False  # Turn it off on readthedocs, otherwise it will fail
+else:
+    autosummary_generate = True
+add_module_names = False
 numpydoc_show_class_members = False
 
 templates_path = ["_templates"]

docs/source/how_it_works.rst

@@ -11,7 +11,7 @@ Automatic cache management
 1. The decorated module (including its source code obtained through `inspect.getsource`) and its args/kwargs.
 2. The inputs provided to the module's forward method.
 
-This hash serves as the cache key for the forward method's output per item in a batch. When our MRU (most-recently-used) cache fills up for the given session, the system continues running the forward method and dismisses the oldest output. This MRU strategy streamlines cache invalidation, aligning with the iterative nature of neural network training, without requiring any additional record-keeping.
+This hash serves as the cache key for the forward method's output per item in a batch. When our MRU (most-recently-used) cache fills up for the given session, the system continues running the forward method and dismisses the newest output. This MRU strategy streamlines cache invalidation, aligning with the iterative nature of neural network training, without requiring any additional record-keeping.
 
 .. warning::
 

torchcache/torchcache.py

@@ -41,7 +41,7 @@ class CachedModule(nn.Module):
 
     .. code-block:: python
 
-        @torchcache(peristent=True)
+        @torchcache(persistent=True)
         class CachedModule(nn.Module):
             def __init__(self, cache_dir: str | Path):
                 self.torchcache_persistent_cache_dir = cache_dir