summaryrefslogtreecommitdiff
path: root/requests_cache/backends/filesystem.py
diff options
context:
space:
mode:
Diffstat (limited to 'requests_cache/backends/filesystem.py')
-rw-r--r--requests_cache/backends/filesystem.py8
1 files changed, 7 insertions, 1 deletions
diff --git a/requests_cache/backends/filesystem.py b/requests_cache/backends/filesystem.py
index 021204b..f633a22 100644
--- a/requests_cache/backends/filesystem.py
+++ b/requests_cache/backends/filesystem.py
@@ -1,3 +1,9 @@
+"""Filesystem cache backend. For usage details, see :ref:`Backends: Filesystem <filesystem>`.
+
+.. automodsumm:: requests_cache.backends.filesystem
+ :classes-only:
+ :nosignatures:
+"""
from contextlib import contextmanager
from os import makedirs
from pathlib import Path
@@ -12,7 +18,7 @@ from .sqlite import AnyPath, SQLiteDict, get_cache_path
class FileCache(BaseCache):
- """Filesystem backend.
+ """Filesystem cache backend.
Args:
cache_name: Base directory for cache files