feat(docs): update theme options and improve documentation

- Add issue button and adjust TOC level in docs theme options
- Simplify description in index.rst
- Add version 0.5 release notes with new features
- Update cache.py with new methods and versionadded markers
- Create exceptions.py with new exception classes

Author: tanbro

docs/conf.py

@@ -62,6 +62,9 @@
     "use_download_button": True,
     "use_fullscreen_button": True,
     "use_repository_button": True,
+    "use_issues_button": True,
+    "use_download_button": True,
+    "show_toc_level": 2,
 }
 
 # -- Options for autodoc ----------------------------------------------------

docs/index.rst

@@ -23,7 +23,7 @@ redis_func_cache
    :target: https://pypi.org/project/redis_func_cache/
 
 .. rubric::
-   ``redis_func_cache`` is a Python library for caching function results in `Redis <https://redis.io/>`_, similar to the caching functionality provided by the standard library's `functools <https://docs.python.org/library/functools.html>`_ module.
+   A Python library for caching function results in Redis, similar to the caching functionality provided by the standard library's functools.cache.
 
 ========== ========= =========
 Release    Version   Built at

src/redis_func_cache/cache.py

@@ -101,6 +101,8 @@ class Mode:
         """A :func:`dataclasses.dataclass` for cache operation mode flags.
 
         Defines how the cache behaves when executing decorated functions.
+
+        .. versionadded:: 0.5
         """
 
         read: bool = True
@@ -167,6 +169,8 @@ def __init__(
 
                 Assigned to property :attr:`update_ttl`.
 
+                .. versionadded:: 0.5
+
             prefix: The prefix for cache keys.
 
                 If not provided, the default is :data:`.DEFAULT_PREFIX`.
@@ -366,6 +370,8 @@ def get_client(self) -> RedisClientTV:
 
         Caution:
             When using the factory pattern (a :term:`callable` object is passed to the ``client`` :term:`argument` of the constructor), **the factory function will be invoked every time this method is called**, and its return value will be used as the method's return value.
+
+        .. versionadded:: 0.5
         """
         if self._redis_instance:
             return self._redis_instance
@@ -846,13 +852,21 @@ def get_mode(self) -> RedisFuncCache.Mode:
         """Return a **copy** of the cache mode.
 
         The cache mode inside the class instance is contextual variable, which is thread local and thread safe.
+
+        .. versionadded:: 0.5
         """
         return copy(self._mode.get())
 
     def set_mode(self, mode: RedisFuncCache.Mode) -> Token[RedisFuncCache.Mode]:
+        """
+        .. versionadded:: 0.5
+        """
         return self._mode.set(mode)
 
     def reset_mode(self, token: Token[RedisFuncCache.Mode]):
+        """
+        .. versionadded:: 0.5
+        """
         self._mode.reset(token)
 
     @contextmanager
@@ -881,6 +895,8 @@ def func(): ...
 
                 with cache.scoped_mode(mode):
                     result = func()  # will be executed without cache write
+
+        .. versionadded:: 0.5
         """
         token = self._mode.set(mode)
         try:
@@ -902,8 +918,10 @@ def disable_rw(self) -> Generator[None, None, None]:
                 def func(): ...
 
 
-                with cache.disabled():
+                with cache.disable_rw():
                     result = func()  # will be executed without cache ability
+
+        .. versionadded:: 0.5
         """
         mode = replace(self._mode.get(), read=False, write=False)
         with self.scoped_mode(mode):
@@ -927,6 +945,8 @@ def func(): ...
 
                 with cache.read_only():
                     result = func()
+
+        .. versionadded:: 0.5
         """
         mode = replace(self._mode.get(), read=True, write=False)
         with self.scoped_mode(mode):
@@ -946,6 +966,8 @@ def func(): ...
 
                 with cache.disable_read():
                     result = func()  # will be executed and result stored in cache, but not read from cache
+
+        .. versionadded:: 0.5
         """
         mode = replace(self._mode.get(), read=False, write=True)
         with self.scoped_mode(mode):

src/redis_func_cache/exceptions.py

@@ -1,3 +1,7 @@
+"""
+.. versionadded:: 0.5
+"""
+
 __all__ = ("BaseCacheError", "CacheMissError")