rst to md a few things to test doc generation

Author: Fabien Coelho

CacheToolsUtils.py

@@ -28,7 +28,7 @@
 
 
 class _MutMapMix:
-    """Convenient MutableMapping Mixin, forward to _cache."""
+    """Convenient MutableMapping Mixin, forward to `_cache`."""
 
     # FIXME coverage reports this as missing with Python 3.14
     _cache: MutableMapping  # pragma: no cover
@@ -53,7 +53,7 @@ def __iter__(self):
 
 
 class _KeyMutMapMix(_MutMapMix):
-    """Convenient MutableMapping Mixin with a key filter, forward to _cache."""
+    """Convenient MutableMapping Mixin with a key filter, forward to `_cache`."""
 
     @abc.abstractmethod
     def _key(self, key: Any) -> Any:  # pragma: no cover
@@ -73,7 +73,7 @@ def __delitem__(self, key: Any):
 
 
 class _StatsMix:
-    """Convenient Mixin to forward stats methods to _cache."""
+    """Convenient Mixin to forward stats methods to `_cache`."""
 
     def hits(self) -> float|None:
         return self._cache.hits()  # type: ignore
@@ -114,9 +114,11 @@ def dbsize(self, *args, **kwargs):
 class DebugCache(_StatsMix, MutableMapping):
     """Debug class.
 
-    :param cache: actual cache
-    :param log: logging instance
-    :param name: name of instance for output
+    Parameters:
+
+    - cache: actual cache
+    - log: logging instance
+    - name: name of instance for output
     """
 
     def __init__(self, cache: MutableMapping, log: logging.Logger, name="cache"):
@@ -162,7 +164,7 @@ def reset(self):  # pragma: no cover
 
 
 class DictCache(_MutMapMix, MutableMapping):
-    """Cache class based on dict."""
+    """Cache class based on `dict`."""
 
     def __init__(self):
         self._cache = dict()
@@ -174,17 +176,19 @@ def clear(self):
 class LockedCache(_MutMapMix, _StatsMix, _RedisMix, MutableMapping):
     """Cache class with a lock.
 
-    :param cache: actual cache.
-    :param lock: lock (context manager) to use
+    Parameters:
 
-    The locked layer should be the last one before the actual cache.
+    - cache: actual cache.
+    - lock: lock (context manager) to use
 
-    .. code-block: python
+    The locked layer should be the last one before the actual cache.
 
-       import threading
-       import cachetools as ct
-       import CacheToolsUtils as ctu
-       cache = ctu.LockedCache(ct.LFUCache(), threading.RLock())
+    ```python
+    import threading
+    import cachetools as ct
+    import CacheToolsUtils as ctu
+    cache = ctu.LockedCache(ct.LFUCache(), threading.RLock())
+    ```
     """
 
     def __init__(self, cache: MutableMapping, lock):