[docs] Ensure detectors have individual headers, general ledgibility improvements

Author: Breakthrough

docs/api.rst

@@ -96,23 +96,6 @@ Functions
 .. automodule:: scenedetect
     :members:
 
-.. toctree::
-    :maxdepth: 3
-    :caption: PySceneDetect Module Documentation
-    :name: fullapitoc
-    :hidden:
-
-    api/migration_guide
-    api/detectors
-    api/scene_manager
-    api/common
-    api/output
-    api/backends
-    api/stats_manager
-    api/detector
-    api/video_stream
-    api/platform
-
 
 =======================================================================
 Logging

docs/api/detectors.rst

@@ -6,19 +6,48 @@ Detectors
 ----------------------------------------
 
 .. automodule:: scenedetect.detectors
-   :members:
+
+AdaptiveDetector
+========================================
 
 .. automodule:: scenedetect.detectors.adaptive_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.adaptive_detector.AdaptiveDetector
    :members:
 
+ContentDetector
+========================================
+
 .. automodule:: scenedetect.detectors.content_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.content_detector.ContentDetector
    :members:
 
+HashDetector
+========================================
+
 .. automodule:: scenedetect.detectors.hash_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.hash_detector.HashDetector
    :members:
 
+HistogramDetector
+========================================
+
 .. automodule:: scenedetect.detectors.histogram_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.histogram_detector.HistogramDetector
    :members:
 
+ThresholdDetector
+========================================
+
 .. automodule:: scenedetect.detectors.threshold_detector
+   :no-members:
+
+.. autoclass:: scenedetect.detectors.threshold_detector.ThresholdDetector
    :members:

docs/api/migration_guide.rst

@@ -2,7 +2,7 @@
 .. _scenedetect-migration-guide:
 
 ***********************************************************************
-Migration Guide: v0.6 to v0.7
+Migration Guide (v0.7)
 ***********************************************************************
 
 PySceneDetect v0.7 is a major release that overhauls timestamp handling to support variable framerate (VFR) videos. While the high-level :func:`scenedetect.detect` workflow is largely unchanged, several internal APIs have been restructured. This guide covers the changes needed to update applications from v0.6 to v0.7.

docs/conf.py

@@ -45,6 +45,9 @@
 autodoc_typehints = "description"
 autodoc_typehints_format = "short"
 
+add_module_names = False
+python_use_unqualified_type_names = True
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 

docs/index.rst

@@ -54,6 +54,7 @@ Table of Contents
     api/video_stream
     api/stats_manager
     api/platform
+    api/migration_guide
 
 =======================================================================
 Indices and Tables

scenedetect/detectors/histogram_detector.py

@@ -132,29 +132,23 @@ def calculate_histogram(
         across all bins.
 
         Args:
-        -----
-        frame_img : np.ndarray
-            The input image in BGR color space, assumed to have shape (height, width, 3)
-            where the last dimension represents the BGR channels.
-        bins : int, optional (default=256)
-            The number of bins to use for the histogram.
-        normalize : bool, optional (default=True)
-            A boolean flag that determines whether the histogram should be normalized
-            such that the sum of all histogram bins equals 1.
+            frame_img: The input image in BGR color space, assumed to have shape
+                (height, width, 3) where the last dimension represents the BGR channels.
+            bins: The number of bins to use for the histogram.
+            normalize: A boolean flag that determines whether the histogram should be
+                normalized such that the sum of all histogram bins equals 1.
 
         Returns:
-        --------
-        np.ndarray
-            A 1D numpy array of length equal to `bins`, representing the histogram of the luma
-            channel. Each element in the array represents the count (or frequency) of a particular
-            luma value in the image. If normalized, these values represent the relative frequency.
-
-        Examples:
-        ---------
-        >>> img = cv2.imread("path_to_image.jpg")
-        >>> hist = calculate_histogram(img, bins=256, normalize=True)
-        >>> print(hist.shape)
-        (256,)
+            A 1D numpy array of length equal to `bins`, representing the histogram of the
+            luma channel. Each element in the array represents the count (or frequency) of
+            a particular luma value in the image. If normalized, these values represent the
+            relative frequency.
+
+        Example:
+            >>> img = cv2.imread("path_to_image.jpg")
+            >>> hist = calculate_histogram(img, bins=256, normalize=True)
+            >>> print(hist.shape)
+            (256,)
         """
         # Extract Luma channel from the frame image
         y, _, _ = cv2.split(cv2.cvtColor(frame_img, cv2.COLOR_BGR2YUV))