WIP

docs/requirements.txt

@@ -1,9 +1,9 @@
 babel==2.16.0 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:368b5b98b37c06b7daf6696391c3240c938b37767d4584413e8438c5c435fa8b \
     --hash=sha256:d1f3554ca26605fe173f3de0c65f750f5a42f924499bf134de6423582298e316
-certifi==2024.7.4 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:5a1e7645bc0ec61a09e26c36f6106dd4cf40c6db3a1fb6352b0244e7fb057c7b \
-    --hash=sha256:c198e21b1289c2ab85ee4e67bb4b4ef3ead0892059901a8d5b622f24a1101e90
+certifi==2024.8.30 ; python_version >= "3.8" and python_version < "4.0" \
+    --hash=sha256:922820b53db7a7257ffbda3f597266d435245903d80737e34f8a45ff3e3230d8 \
+    --hash=sha256:bec941d2aa8195e248a60b31ff9f0558284cf01a52591ceda73ea9afffd69fd9
 charset-normalizer==3.3.2 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027 \
     --hash=sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087 \
@@ -186,17 +186,18 @@ mkdocs-get-deps==0.2.0 ; python_version >= "3.8" and python_version < "4.0" \
 mkdocs-material-extensions==1.3.1 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:10c9511cea88f568257f960358a467d12b970e1f7b2c0e5fb2bb48cab1928443 \
     --hash=sha256:adff8b62700b25cb77b53358dad940f3ef973dd6db797907c49e3c2ef3ab4e31
-mkdocs-material==9.5.33 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:d23a8b5e3243c9b2f29cdfe83051104a8024b767312dc8fde05ebe91ad55d89d \
-    --hash=sha256:dbc79cf0fdc6e2c366aa987de8b0c9d4e2bb9f156e7466786ba2fd0f9bf7ffca
-mkdocs==1.6.0 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:1eb5cb7676b7d89323e62b56235010216319217d4af5ddc543a91beb8d125ea7 \
-    --hash=sha256:a73f735824ef83a4f3bcb7a231dcab23f5a838f88b7efc54a0eef5fbdbc3c512
+mkdocs-material==9.5.34 ; python_version >= "3.8" and python_version < "4.0" \
+    --hash=sha256:1e60ddf716cfb5679dfd65900b8a25d277064ed82d9a53cd5190e3f894df7840 \
+    --hash=sha256:54caa8be708de2b75167fd4d3b9f3d949579294f49cb242515d4653dbee9227e
+mkdocs==1.6.1 ; python_version >= "3.8" and python_version < "4.0" \
+    --hash=sha256:7b432f01d928c084353ab39c57282f29f92136665bdd6abf7c1ec8d822ef86f2 \
+    --hash=sha256:db91759624d1647f3f34aa0c3f327dd2601beae39a366d6e064c03468d35c20e
 packaging==24.1 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002 \
     --hash=sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124
-paginate==0.5.6 ; python_version >= "3.8" and python_version < "4.0" \
-    --hash=sha256:5e6007b6a9398177a7e1648d04fdd9f8c9766a1a945bceac82f1929e8c78af2d
+paginate==0.5.7 ; python_version >= "3.8" and python_version < "4.0" \
+    --hash=sha256:22bd083ab41e1a8b4f3690544afb2c60c25e5c9a63a30fa2f483f6c60c8e5945 \
+    --hash=sha256:b885e2af73abcf01d9559fd5216b57ef722f8c42affbb63942377668e35c7591
 pathspec==0.12.1 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08 \
     --hash=sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712
@@ -358,6 +359,9 @@ requests==2.32.3 ; python_version >= "3.8" and python_version < "4.0" \
 six==1.16.0 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:1e61c37477a1626458e36f7b1d82aa5c9b094fa4802892072e49de9c60c4c926 \
     --hash=sha256:8abb2f1d86890a2dfb989f9a77cfcfd3e47c2a354b01111771326f8aa26e0254
+termynal==0.12.1 ; python_full_version >= "3.8.1" and python_version < "4.0" \
+    --hash=sha256:48842b5066eee25d5efef570b776bbc7e2875fca547c38c39e73fec1bb562fa9 \
+    --hash=sha256:8420fc7ddc9daa5733c5aa370e7d2567a0e9299caa6e47fe8b5efd228fdffc47
 urllib3==2.2.2 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:a448b2f64d686155468037e1ace9f2d2199776e17f0a46610480d311f73e3472 \
     --hash=sha256:dd505485549a7a552833da5e6063639d0d177c04f23bc3864e41e5dc5f612168
@@ -397,6 +401,6 @@ watchdog==4.0.2 ; python_version >= "3.8" and python_version < "4.0" \
     --hash=sha256:f5315a8c8dd6dd9425b974515081fc0aadca1d1d61e078d2246509fd756141ee \
     --hash=sha256:f6ee8dedd255087bc7fe82adf046f0b75479b989185fb0bdf9a98b612170eac7 \
     --hash=sha256:f7c739888c20f99824f7aa9d31ac8a97353e22d0c0e54703a547a218f6637eb3
-zipp==3.20.0 ; python_version >= "3.8" and python_version < "3.10" \
-    --hash=sha256:0145e43d89664cfe1a2e533adc75adafed82fe2da404b4bbb6b026c0157bdb31 \
-    --hash=sha256:58da6168be89f0be59beb194da1250516fdaa062ccebd30127ac65d30045e10d
+zipp==3.20.1 ; python_version >= "3.8" and python_version < "3.10" \
+    --hash=sha256:9960cd8967c8f85a56f920d5d507274e74f9ff813a0ab8889a5b5be2daf44064 \
+    --hash=sha256:c22b14cc4763c5a5b04134207736c107db42e9d3ef2d9779d465f5f1bcba572b

docs/setup.md

@@ -1,10 +1,12 @@
 ## Installation
 To install:
+
+<!-- termynal -->
 ```bash
-pip install py-cachify
+$ pip install py-cachify
 
-# or if using poetry
-poetry add py-cachify
+---> 100%
+Successfully installed py-cachify
 ```
 
 ## Initialization (working with in-memory cache or `redis`)

mkdocs.yml

@@ -1,24 +1,90 @@
-site_name: py-cachify's documentation
+site_name: py-cachify
+site_description: py-cachify. Cache and locks made easy. Fully type annotated. 100% coverage.
+repo_name: EzyGang/py-cachify
+repo_url: https://github.com/EzyGang/py-cachify
+
+
 theme:
   name: material
   palette:
+  - media: '(prefers-color-scheme: light)'
+    scheme: default
+    primary: black
+    accent: cyan
+    toggle:
+      icon: material/lightbulb
+      name: Switch to dark mode
+  - media: '(prefers-color-scheme: dark)'
     scheme: slate
+    primary: black
+    accent: cyan
+    toggle:
+      icon: material/lightbulb-outline
+      name: Switch to light mode
   icon:
     repo: fontawesome/brands/github
   features:
+    - content.code.annotate
     - content.code.copy
+    - content.footnote.tooltips
+    - content.tabs.link
+    - content.tooltips
+    - navigation.footer
+    - navigation.indexes
+    - navigation.instant
+    - navigation.instant.prefetch
+    - navigation.instant.progress
+    - navigation.path
     - navigation.tabs
     - navigation.tabs.sticky
     - navigation.top
+    - navigation.tracking
+    - search.highlight
+    - search.share
+    - search.suggest
+    - toc.follow
 markdown_extensions:
-  - pymdownx.highlight:
+  toc:
+    permalink: true
+  pymdownx.highlight:
       anchor_linenums: true
       line_spans: __span
       pygments_lang_class: true
-  - pymdownx.inlinehilite
-  - pymdownx.snippets
-  - pymdownx.superfences
-repo_url: https://github.com/EzyGang/py-cachify
+  pymdownx.inlinehilite:
+  pymdownx.snippets:
+  pymdownx.betterem:
+    smart_enable: all
+  pymdownx.caret:
+  pymdownx.keys:
+  pymdownx.mark:
+  pymdownx.superfences:
+    custom_fences:
+    - name: mermaid
+      class: mermaid
+      format: !!python/name:pymdownx.superfences.fence_code_format
+  pymdownx.tilde:
+
+  # pymdownx blocks
+  pymdownx.blocks.admonition:
+    types:
+    - note
+    - attention
+    - caution
+    - danger
+    - error
+    - tip
+    - hint
+    - warning
+    # Custom types
+    - info
+    - check
+  pymdownx.blocks.details:
+  pymdownx.blocks.tab:
+    alternate_style: True
+plugins:
+    # Material for MkDocs
+  search:
+  termynal:
 nav:
   - Introduction: 'index.md'
   - Installation and Setup: 'setup.md'