docs: improve type hinting and update documentation dependencies

- Add sphinx_autodoc_typehints extension to enable type hinting in docs
- Update autodoc_typehints setting to "both" for more comprehensive type information
- Install sphinx-autodoc-typehints in docs/requirements.txt and pyproject.toml
- Update documentation for RedisFuncCache class to use method references

Author: tanbro

docs/conf.py

@@ -37,6 +37,7 @@
     "sphinx_copybutton",
     "versionwarning.extension",
     "sphinxcontrib.mermaid",
+    "sphinx_autodoc_typehints",
 ]
 
 source_suffix = {
@@ -69,7 +70,7 @@
 
 # Automatically extract typehints when specified and place them in
 # descriptions of the relevant function/method.
-autodoc_typehints = "description"
+autodoc_typehints = "both"
 
 # Don't show class signature with the class' name.
 # autodoc_class_signature = "separated"

docs/requirements.txt

@@ -11,3 +11,5 @@ sphinx-copybutton
 sphinx-inline-tabs
 sphinx_tippy
 sphinx-version-warning
+
+sphinx-autodoc-typehint

pyproject.toml

@@ -92,6 +92,7 @@ docs = [
   "sphinx-inline-tabs",
   "sphinx_tippy",
   "sphinx-version-warning",
+  "sphinx-autodoc-typehints",
 ]
 test = [
   "pytest",

src/redis_func_cache/cache.py

@@ -165,10 +165,10 @@ def __init__(
 
                 or a function that returns one of these objects.
 
-                Access the client via the :attr:`client` property.
+                Get the client via :meth:`get_client`.
 
                 Caution:
-                    If a :term:`callable` object is passed here, it will be executed **every time** the :attr:`.client` property is accessed.
+                    If a :term:`callable` object is passed here, it will be executed **every time** :meth:`get_client` is called.
 
             maxsize: The maximum size of the cache.
 
@@ -881,7 +881,7 @@ async def awrapper(*user_args, **user_kwargs):
     __call__ = decorate
 
     @contextmanager
-    def mode(self, mode: Mode) -> Generator[None, None, None]:
+    def mode(self, mode: RedisFuncCache.Mode) -> Generator[None, None, None]:
         """A context manager to control cache behavior.
 
         Args:
@@ -894,7 +894,7 @@ def mode(self, mode: Mode) -> Generator[None, None, None]:
             self._mode.reset(token)
 
     @contextmanager
-    def mask_mode(self, mode: Mode) -> Generator[None, None, None]:
+    def mask_mode(self, mode: RedisFuncCache.Mode) -> Generator[None, None, None]:
         """Apply a mode mask using bitwise AND operation to restrict cache capabilities.
 
         This context manager allows you to temporarily restrict the current cache mode