Add mkdocs

Author: devbijay

.github/workflows/ci.yml

@@ -0,0 +1,29 @@
+name: ci
+on:
+  push:
+    branches:
+      - master
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+      - uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
+      - uses: actions/cache@v4
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material mkdocstrings[python]
+      - run: mkdocs gh-deploy --force

.readthedocs.yaml

@@ -0,0 +1,37 @@
+# API Reference
+
+## Main Cache Interface
+
+::: fast_cache.FastAPICache
+    options:
+      show_source: true
+      show_signature: true
+      show_root_heading: true
+
+## Backends
+::: fast_cache.InMemoryBackend
+    options:
+      show_source: true
+      show_signature: true
+      show_root_heading: true
+
+::: fast_cache.RedisBackend
+    options:
+      show_source: true
+      show_signature: true
+      show_root_heading: true
+
+::: fast_cache.PostgresBackend
+    options:
+      show_source: true
+      show_signature: true
+      show_root_heading: true
+::: fast_cache.MemcachedBackend
+    options:
+      show_source: true
+      show_signature: true
+      show_root_heading: true
+
+## Backend Base Class
+
+::: fast_cache.backends.backend.CacheBackend

docs/api.md

@@ -0,0 +1,64 @@
+# 🗄️ Backends Overview
+
+FastAPI Cachekit supports multiple cache backends, so you can choose the best fit for your application’s needs—whether you want blazing-fast in-memory caching for development, or distributed caching for production.
+
+---
+
+## Supported Backends
+
+| Backend            | Description                                      | Best For                | Docs                |
+|--------------------|--------------------------------------------------|-------------------------|---------------------|
+| InMemoryBackend    | Stores cache in the app’s memory (LRU support)   | Development, testing    | [In-Memory](backends/in_memory.md) |
+| RedisBackend       | Uses Redis for distributed, production caching    | Production, scaling     | [Redis](backends/redis.md)         |
+| PostgresBackend    | Uses PostgreSQL for persistent SQL-based caching  | Data persistence, SQL   | [Postgres](backends/postgres.md)   |
+| MemcachedBackend   | Uses Memcached for high-speed distributed caching | High-speed, stateless   | [Memcached](backends/memcached.md) |
+
+---
+
+## How to Choose a Backend
+
+- **InMemoryBackend**  
+  - 🟢 Easiest to set up, no extra dependencies.
+  - 🔴 Not shared between processes or servers.
+  - 🔴 Data lost on restart.
+
+- **RedisBackend**  
+  - 🟢 Distributed, scalable, and fast.
+  - 🟢 Widely used in production.
+  - 🔴 Requires a running Redis server.
+
+- **PostgresBackend**  
+  - 🟢 Uses your existing PostgreSQL database.
+  - 🟢 Data persists across restarts.
+  - 🔴 Slightly slower than in-memory or Redis.
+
+- **MemcachedBackend**  
+  - 🟢 High-speed, distributed, simple.
+  - 🔴 No persistence (data lost on restart).
+  - 🔴 No built-in authentication by default.
+
+---
+
+## Installation for Each Backend
+
+See the [Installation Guide](installation.md) for details on installing optional dependencies for each backend.
+
+---
+
+## Backend Setup Guides
+
+- [In-Memory Backend](backends/in_memory.md)
+- [Redis Backend](backends/redis.md)
+- [Postgres Backend](backends/postgres.md)
+- [Memcached Backend](backends/memcached.md)
+
+---
+
+## Adding More Backends
+
+Want to add support for another backend?  
+Open an issue or submit a pull request on [GitHub](https://github.com/devbijay/fast-cache)!
+
+---
+
+**FastAPI Cachekit makes it easy to switch backends with minimal code changes—just swap the backend class and you’re ready to go!**

docs/backends.md

@@ -0,0 +1,73 @@
+# In-Memory Backend
+
+The **InMemoryBackend** is the simplest backend for FastAPI Cachekit.  
+It stores all cached data in the application's memory, making it ideal for local development, testing, or small-scale deployments.
+
+---
+
+## 🚀 Installation
+
+No extra dependencies are required!  
+The in-memory backend is **built-in** and works out of the box.
+
+```bash
+pip install fastapi-cachekit
+```
+
+---
+
+## ⚙️ Setup with FastAPI
+
+```python
+from fast_cache import FastAPICache, InMemoryBackend
+
+cache = FastAPICache()
+backend = InMemoryBackend(namespace="myapp-cache")
+cache.init_app(app, backend)
+```
+
+- `namespace` (optional): Prefix for all cache keys (default: `"fastapi-cache"`).
+
+---
+
+## 🧑‍💻 Example Usage
+
+```python
+@app.get("/expensive")
+@cache.cached(expire=60)
+async def expensive_operation(x: int):
+    # This result will be cached in memory for 60 seconds
+    return {"result": x * 2}
+```
+
+---
+
+## 📝 Options
+
+- **namespace**:  
+  A string prefix for all cache keys. Useful if you run multiple apps in the same process.
+
+- **max_size** (optional):  
+  Maximum number of items to store in the cache.  
+  If set, the cache will evict the least recently used (LRU) items when full.
+
+```python
+backend = InMemoryBackend(namespace="myapp-cache", max_size=1000)
+```
+
+---
+
+## ⚠️ Limitations
+
+- **Not shared between processes or servers**:  
+  Each process has its own cache. Not suitable for distributed or multi-worker deployments.
+- **Data is lost on restart**:  
+  The cache is cleared when the app restarts.
+- **Best for development, testing, or single-process apps**.
+
+---
+## 🔗 See Also
+
+- [Backends Overview](../backends.md)
+- [API Reference](../api.md)
+- [Usage Guide](../usage.md)

docs/backends/in_memory.md

@@ -0,0 +1,106 @@
+# Memcached Backend
+
+The **MemcachedBackend** allows you to use a Memcached server as a cache store for FastAPI Cachekit.  
+This backend is ideal for high-speed, distributed caching in stateless applications.
+
+---
+
+## 🚀 Installation
+
+Install FastAPI Cachekit with Memcached support:
+
+```bash
+pip install fastapi-cachekit[memcached]
+```
+
+Or with other tools:
+
+- **uv**
+```bash
+uv add fastapi-cachekit[memcached]
+```
+- **poetry**
+```bash
+poetry add fastapi-cachekit -E memcached
+```
+
+---
+
+## ⚙️ Setup with FastAPI
+
+```python
+from fast_cache import cache, MemcachedBackend
+
+backend = MemcachedBackend(
+    host="localhost",
+    port=11211,
+    namespace="myapp-cache"
+)
+cache.init_app(app, backend)
+```
+
+- `host`: Memcached server host (default: `"localhost"`)
+- `port`: Memcached server port (default: `11211`)
+- `namespace`: Prefix for all cache keys (default: `"fastapi-cache"`)
+
+---
+
+## 🧑‍💻 Example Usage
+
+```python
+@app.get("/expensive")
+@cache.cached(expire=60)
+async def expensive_operation(x: int):
+    # This result will be cached in Memcached for 60 seconds
+    return {"result": x * 2}
+```
+
+---
+
+## 📝 Options
+
+- **host**:  
+  Memcached server host (default: `"localhost"`)
+
+- **port**:  
+  Memcached server port (default: `11211`)
+
+- **namespace**:  
+  String prefix for all cache keys (default: `"fastapi-cache"`)
+
+
+- **pool_size**:  
+  Maximum number of connections in the sync pool (default: `2`)
+
+---
+
+## ⚡️ Notes
+
+- **Memcached is a high-speed, in-memory, distributed cache.**
+- **No persistence:** Data is lost if the server restarts.
+- **No built-in authentication by default:**  
+  SASL authentication is available if enabled on the server and configured in the backend.
+- **Best for stateless, high-throughput caching.**
+
+---
+
+## 🛠️ Example: Using SASL Authentication
+
+If your Memcached server is configured with SASL:
+
+```python
+backend = MemcachedBackend(
+    host="localhost",
+    port=11211,
+    username="myuser",
+    password="mypassword"
+)
+```
+
+---
+
+## 🔗 See Also
+
+- [Backends Overview](../backends.md)
+- [API Reference](../api.md)
+- [Usage Guide](../usage.md)