📖 improve documentation

docs/detection/annotate.md

@@ -0,0 +1,3 @@
+## BoxAnnotator
+
+:::supervision.detection.annotate.BoxAnnotator

mkdocs.yml

@@ -26,8 +26,9 @@ nav:
   - API reference:
     - Video: video.md
     - Detection:
-        - Core: detection_core.md
-        - Utils: detection_utils.md
+        - Core: detection/core.md
+        - Annotate: detection/annotate.md
+        - Utils: detection/utils.md
     - Draw:
         - Utils: draw_utils.md
     - Notebook: notebook.md

supervision/detection/annotate.py

@@ -8,6 +8,19 @@ from supervision.draw.color import Color, ColorPalette
 
 
 class BoxAnnotator:
+    """
+    A class for drawing bounding boxes on an image using detections provided.
+
+    Attributes:
+        color (Union[Color, ColorPalette]): The color to draw the bounding box, can be a single color or a color palette
+        thickness (int): The thickness of the bounding box lines, default is 2
+        text_color (Color): The color of the text on the bounding box, default is white
+        text_scale (float): The scale of the text on the bounding box, default is 0.5
+        text_thickness (int): The thickness of the text on the bounding box, default is 1
+        text_padding (int): The padding around the text on the bounding box, default is 5
+
+    """
+
     def __init__(
         self,
         color: Union[Color, ColorPalette] = ColorPalette.default(),
@@ -17,18 +30,6 @@ class BoxAnnotator:
         text_thickness: int = 1,
         text_padding: int = 10,
     ):
-        """
-        A class for drawing bounding boxes on an image using detections provided.
-
-        Attributes:
-            color (Union[Color, ColorPalette]): The color to draw the bounding box, can be a single color or a color palette
-            thickness (int): The thickness of the bounding box lines, default is 2
-            text_color (Color): The color of the text on the bounding box, default is white
-            text_scale (float): The scale of the text on the bounding box, default is 0.5
-            text_thickness (int): The thickness of the text on the bounding box, default is 1
-            text_padding (int): The padding around the text on the bounding box, default is 5
-
-        """
         self.color: Union[Color, ColorPalette] = color
         self.thickness: int = thickness
         self.text_color: Color = text_color