chore: documentation (#76)

* chore: update docstring example to use python code block

* docs: add documentation

* feat: add docs build + fix other workdlows

* fix: add missing return type

src/fastapi_toolsets/metrics/handler.py

@@ -40,12 +40,14 @@ def init_metrics(
         The same FastAPI instance (for chaining).
 
     Example:
+        ```python
         from fastapi import FastAPI
         from fastapi_toolsets.metrics import MetricsRegistry, init_metrics
 
         metrics = MetricsRegistry()
         app = FastAPI()
         init_metrics(app, registry=metrics)
+        ```
     """
     for provider in registry.get_providers():
         logger.debug("Initialising metric provider '%s'", provider.name)

src/fastapi_toolsets/metrics/registry.py

@@ -22,6 +22,7 @@ class MetricsRegistry:
     """Registry for managing Prometheus metric providers and collectors.
 
     Example:
+        ```python
         from prometheus_client import Counter, Gauge
         from fastapi_toolsets.metrics import MetricsRegistry
 
@@ -38,6 +39,7 @@ class MetricsRegistry:
         @metrics.register(collect=True)
         def collect_queue_depth(gauge=Gauge("queue_depth", "Current queue depth")):
             gauge.set(get_current_queue_depth())
+        ```
     """
 
     def __init__(self) -> None:
@@ -61,6 +63,7 @@ class MetricsRegistry:
                 If ``False`` (default), called once at init time.
 
         Example:
+            ```python
             @metrics.register
             def my_counter():
                 return Counter("my_counter", "A counter")
@@ -68,6 +71,7 @@ class MetricsRegistry:
             @metrics.register(collect=True, name="queue")
             def collect_queue_depth():
                 gauge.set(compute_depth())
+            ```
         """
 
         def decorator(fn: Callable[..., Any]) -> Callable[..., Any]:
@@ -93,6 +97,7 @@ class MetricsRegistry:
             ValueError: If a metric name already exists in the current registry.
 
         Example:
+            ```python
             main = MetricsRegistry()
             sub = MetricsRegistry()
 
@@ -101,6 +106,7 @@ class MetricsRegistry:
                 return Counter("sub_total", "Sub counter")
 
             main.include_registry(sub)
+            ```
         """
         for metric_name, definition in registry._metrics.items():
             if metric_name in self._metrics: