Make _check_and_modify_bbox private as it's not a user facing method. Change docs to reflect it

Author: shoumikchow

bbox_visualizer/bbox_visualizer.py

@@ -6,10 +6,12 @@
 font = cv2.FONT_HERSHEY_SIMPLEX
 
 
-def check_and_modify_bbox(
+def _check_and_modify_bbox(
     bbox: List[int], img_size: Tuple[int, int, int], margin: int = 0
 ) -> List[int]:
-    """Checks and adjusts bounding box coordinates to fit within image boundaries.
+    """Internal function to check and adjust bounding box coordinates.
+
+    .. private::
 
     Trimming rules:
         - xmin/ymin: Set to margin if negative
@@ -50,7 +52,7 @@ def draw_rectangle(
     Returns:
         Image with drawn rectangle
     """
-    bbox = check_and_modify_bbox(bbox, img.shape)
+    bbox = _check_and_modify_bbox(bbox, img.shape)
 
     output = img.copy()
     if not is_opaque:

docs/conf.py

@@ -173,9 +173,20 @@
     'members': True,
     'member-order': 'bysource',
     'special-members': '__init__',
-    'undoc-members': True,
-    'exclude-members': '__weakref__'
+    'undoc-members': False,
+    'exclude-members': '__weakref__',
+    'private-members': False,
+    'show-inheritance': True
 }
 
+# Don't show type hints in the signature - they're already in the parameter list
+autodoc_typehints = 'description'
+
+# Don't show the module name in the function/class signature
+add_module_names = False
+
+# Sort members by source order
+autodoc_member_order = 'bysource'
+