[docs] Normalize meta tags

Breakthrough · Breakthrough · commit 3aabe15b2dcb · 2026-05-04T22:04:15.000-04:00
diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml
@@ -1,6 +1,3 @@
-# Checks that the CLI docs are up-to-date. If this fails on your PR, there may be some changes
-# to the command-line docs that were not updated. Run `python docs/generate_cli_docs.py` from
-# the root PySceneDetect source folder and commit the changes to resolve the issue.
 name: Check Documentation
 
 on:
@@ -10,10 +7,12 @@ on:
     paths:
       - docs/**
       - scenedetect/**
+      - website/**
   push:
     paths:
       - docs/**
       - scenedetect/**
+      - website/**
     branches:
       - main
       - 'releases/**'
@@ -37,7 +36,7 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install --upgrade pip build wheel virtualenv
-          pip install .[docs]
+          pip install .[docs,website]
           pip install -r packaging/windows/requirements.txt
 
 
@@ -49,3 +48,13 @@ jobs:
             echo "Re-run `python docs/generate_cli_docs.py` to update and commit the result."
             exit 1
           fi
+
+      - name: Build Sphinx Reference (warnings as errors)
+        shell: bash
+        run: |
+          sphinx-build -W --keep-going -b html docs docs/_build/html
+
+      - name: Build MkDocs Website (--strict)
+        shell: bash
+        run: |
+          mkdocs build --strict -f website/mkdocs.yml
diff --git a/docs/api.rst b/docs/api.rst
@@ -9,15 +9,15 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
 
     * :ref:`scenedetect.detectors 🕵️ <scenedetect-detectors>`: detection algorithms:
 
-        * :mod:`AdaptiveDetector <scenedetect.detectors.adaptive_detector>` finds fast cuts using rolling average of HSL changes
+        * :class:`AdaptiveDetector <scenedetect.detectors.adaptive_detector.AdaptiveDetector>`: finds fast cuts using rolling average of HSL changes
 
-        * :mod:`ContentDetector <scenedetect.detectors.content_detector>`: detects fast cuts using weighted average of HSV changes
+        * :class:`ContentDetector <scenedetect.detectors.content_detector.ContentDetector>`: detects fast cuts using weighted average of HSV changes
 
-        * :mod:`ThresholdDetector <scenedetect.detectors.threshold_detector>`: finds fades in/out using average pixel intensity changes in RGB
+        * :class:`ThresholdDetector <scenedetect.detectors.threshold_detector.ThresholdDetector>`: finds fades in/out using average pixel intensity changes in RGB
 
-        * :mod:`HistogramDetector <scenedetect.detectors.histogram_detector>` finds fast cuts using HSV histogram changes
+        * :class:`HistogramDetector <scenedetect.detectors.histogram_detector.HistogramDetector>`: finds fast cuts using HSV histogram changes
 
-        * :mod:`HashDetector <scenedetect.detectors.hash_detector>`: finds fast cuts using perceptual image hashing
+        * :class:`HashDetector <scenedetect.detectors.hash_detector.HashDetector>`: finds fast cuts using perceptual image hashing
 
     * :ref:`scenedetect.output ✂️ <scenedetect-output>`: Output formats:
 
@@ -41,7 +41,7 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
 
     * :ref:`scenedetect.detector 🌐 <scenedetect-detector>`: the interface (:class:`SceneDetector <scenedetect.detector.SceneDetector>`) that detectors must implement to be compatible with PySceneDetect
 
-    * :ref:`scenedetect.video_stream  <scenedetect-video_stream>`: the interface (:class:`VideoStream <scenedetect.video_stream.VideoStream>`) that detectors must implement to be compatible with PySceneDetect
+    * :ref:`scenedetect.video_stream 📹 <scenedetect-video_stream>`: the interface (:class:`VideoStream <scenedetect.video_stream.VideoStream>`) that video backends must implement to be compatible with PySceneDetect
 
     * :ref:`scenedetect.stats_manager 🧮 <scenedetect-stats_manager>`: the :class:`StatsManager <scenedetect.stats_manager.StatsManager>` allows you to store detection metrics for each frame and save them to CSV for further analysis
 
diff --git a/docs/api/backends.rst b/docs/api/backends.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-backends:
 
-----------------------------------------
+--------------
 Video Backends
-----------------------------------------
+--------------
 
 .. automodule:: scenedetect.backends
    :members:
diff --git a/docs/api/common.rst b/docs/api/common.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-common:
 
----------------------------------------------------------------
+------
 Common
----------------------------------------------------------------
+------
 
 .. automodule:: scenedetect.common
    :members:
diff --git a/docs/api/detector.rst b/docs/api/detector.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-detector:
 
--------------------------------------------------
+------------------
 Detector Interface
--------------------------------------------------
+------------------
 
 .. automodule:: scenedetect.detector
    :members:
diff --git a/docs/api/detectors.rst b/docs/api/detectors.rst
@@ -1,14 +1,14 @@
 
 .. _scenedetect-detectors:
 
-----------------------------------------
+---------
 Detectors
-----------------------------------------
+---------
 
 .. automodule:: scenedetect.detectors
 
 AdaptiveDetector
-========================================
+================
 
 .. automodule:: scenedetect.detectors.adaptive_detector
    :no-members:
@@ -17,7 +17,7 @@ AdaptiveDetector
    :members:
 
 ContentDetector
-========================================
+===============
 
 .. automodule:: scenedetect.detectors.content_detector
    :no-members:
@@ -26,7 +26,7 @@ ContentDetector
    :members:
 
 HashDetector
-========================================
+============
 
 .. automodule:: scenedetect.detectors.hash_detector
    :no-members:
@@ -35,7 +35,7 @@ HashDetector
    :members:
 
 HistogramDetector
-========================================
+=================
 
 .. automodule:: scenedetect.detectors.histogram_detector
    :no-members:
@@ -44,7 +44,7 @@ HistogramDetector
    :members:
 
 ThresholdDetector
-========================================
+=================
 
 .. automodule:: scenedetect.detectors.threshold_detector
    :no-members:
diff --git a/docs/api/output.rst b/docs/api/output.rst
@@ -1,36 +1,9 @@
 
-
 .. _scenedetect-output:
 
 ------
 Output
 ------
 
-.. autofunction:: scenedetect.output.save_images
-
-.. autofunction:: scenedetect.output.is_ffmpeg_available
-
-.. autofunction:: scenedetect.output.split_video_ffmpeg
-
-.. autofunction:: scenedetect.output.is_mkvmerge_available
-
-.. autofunction:: scenedetect.output.split_video_mkvmerge
-
-.. autofunction:: scenedetect.output.write_scene_list_html
-
-.. autofunction:: scenedetect.output.write_scene_list
-
-.. autofunction:: scenedetect.output.write_scene_list_edl
-
-.. autofunction:: scenedetect.output.write_scene_list_fcpx
-
-.. autofunction:: scenedetect.output.write_scene_list_fcp7
-
-.. autofunction:: scenedetect.output.write_scene_list_otio
-
-.. autoclass:: scenedetect.output.SceneMetadata
-
-.. autoclass:: scenedetect.output.VideoMetadata
-
-.. autofunction:: scenedetect.output.default_formatter
-
+.. automodule:: scenedetect.output
+   :members:
diff --git a/docs/api/platform.rst b/docs/api/platform.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-platform:
 
----------------------------------------------------------------
+------------------
 Platform & Logging
----------------------------------------------------------------
+------------------
 
 .. automodule:: scenedetect.platform
-    :members:
+   :members:
diff --git a/docs/api/scene_manager.rst b/docs/api/scene_manager.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-scene_manager:
 
------------------------------------------------------------------------
+-------------
 Scene Manager
------------------------------------------------------------------------
+-------------
 
 .. automodule:: scenedetect.scene_manager
    :members:
diff --git a/docs/api/stats_manager.rst b/docs/api/stats_manager.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-stats_manager:
 
------------------------------------------------------------------------
+-------------
 Stats Manager
------------------------------------------------------------------------
+-------------
 
 .. automodule:: scenedetect.stats_manager
    :members:
diff --git a/docs/api/video_stream.rst b/docs/api/video_stream.rst
@@ -1,9 +1,9 @@
 
 .. _scenedetect-video_stream:
 
----------------------------------------------------------------
+----------------
 Stream Interface
----------------------------------------------------------------
+----------------
 
 .. automodule:: scenedetect.video_stream
    :members:
diff --git a/scenedetect/common.py b/scenedetect/common.py
@@ -409,7 +409,7 @@ def get_timecode(
     ) -> str:
         """Get a formatted timecode string of the form HH:MM:SS[.nnn].
 
-        Args:
+        Arguments:
             precision: The number of decimal places to include in the output ``[.nnn]``.
             use_rounding: Rounds the output to the desired precision. If False, the value
                 will be truncated to the specified precision.
diff --git a/scenedetect/detector.py b/scenedetect/detector.py
@@ -51,7 +51,7 @@ def process_frame(
     ) -> list[FrameTimecode]:
         """Process the next frame. `timecode` is assumed to be sequential.
 
-        Args:
+        Arguments:
             timecode: Timecode corresponding to the frame being processed.
             frame_img: Video frame as a 24-bit BGR image.
 
@@ -64,7 +64,7 @@ def process_frame(
     def post_process(self, timecode: FrameTimecode) -> list[FrameTimecode]:
         """Called after there are no more frames to process.
 
-        Args:
+        Arguments:
             timecode: The last position in the video which was read.
 
         Returns:
diff --git a/scenedetect/detectors/content_detector.py b/scenedetect/detectors/content_detector.py
@@ -194,7 +194,7 @@ def process_frame(
     ) -> list[FrameTimecode]:
         """Process the next frame. `frame_num` is assumed to be sequential.
 
-        Args:
+        Arguments:
             frame_num (int): Frame number of frame that is being passed. Can start from any value
                 but must remain sequential.
             frame_img (numpy.ndarray or None): Video frame corresponding to `frame_img`.
diff --git a/scenedetect/detectors/histogram_detector.py b/scenedetect/detectors/histogram_detector.py
@@ -131,7 +131,7 @@ def calculate_histogram(
         the specified number of bins, and optionally normalizes this histogram to have a sum of one
         across all bins.
 
-        Args:
+        Arguments:
             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.
diff --git a/scenedetect/detectors/threshold_detector.py b/scenedetect/detectors/threshold_detector.py
@@ -102,7 +102,7 @@ def process_frame(
     ) -> list[FrameTimecode]:
         """Process the next frame.
 
-        Args:
+        Arguments:
             timecode: FrameTimecode of the current frame position.
             frame_img (numpy.ndarray or None): Video frame corresponding to `timecode`.
 
diff --git a/website/mkdocs.yml b/website/mkdocs.yml
@@ -14,8 +14,8 @@ theme:
     logo: img/pyscenedetect_logo_small.png
     favicon: img/favicon.ico
     custom_dir: overrides
-# TODO: deprecated option for this theme
-google_analytics: ['UA-72551323-1', 'auto']
+# Google Analytics is injected manually via overrides/main.html (the top-level
+# `google_analytics` option was deprecated and removed from MkDocs).
 
 nav:
 - 'PySceneDetect':
diff --git a/website/overrides/main.html b/website/overrides/main.html
@@ -9,3 +9,14 @@
 <img src="{{ config.theme.logo|url }}" class="logo" id="side-nav-logo" alt="{% trans %}Logo{% endtrans %}"/>
 </a>
 {% endblock %}
+
+{% block extrahead %}
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+  ga('create', 'UA-72551323-1', 'auto');
+  ga('send', 'pageview');
+</script>
+{% endblock %}
diff --git a/website/pages/api.md b/website/pages/api.md
@@ -15,7 +15,7 @@ Internally, this detector functions by converting the colorspace of each decoded
 
 `detect-content` also has edge detection, which can be enabled by providing a set of 4 numbers in the form (*delta_hue*, *delta_sat*, *delta_lum*, *delta_edges*). Changes in edges are typically larger than the other components, so threshold may need to be increased accordingly.  For example, `-w 1.0 0.5 1.0 0.2 -t 32` is a good starting point to use with edge detection.  The default weights are `--weights 1.0 1.0 1.0 0.0` which does not include edges, but this may change in the future.
 
-See [the documentation for detect-content](../docs/latest/cli/detectors.html#detect-content) for details.
+See [the documentation for detect-content](https://www.scenedetect.com/docs/latest/cli/detectors.html#detect-content) for details.
 
 ## Adaptive Content Detector
 
@@ -36,7 +36,7 @@ The perceptual hash detector (`detect-hash`) calculates a hash for a frame and c
 
 # Creating New Detection Algorithms
 
-All scene detection algorithms must inherit from [the base `SceneDetector` class](../docs/latest/api/detector.html). Note that the current SceneDetector API is under development and expected to change somewhat before v1.0 is released, so make sure to pin your `scenedetect` dependency to the correct API version (e.g. `scenedetect < 0.6`, `scenedetect < 0.7`, etc...).
+All scene detection algorithms must inherit from [the base `SceneDetector` class](https://www.scenedetect.com/docs/latest/api/detector.html). Note that the current SceneDetector API is under development and expected to change somewhat before v1.0 is released, so make sure to pin your `scenedetect` dependency to the correct API version (e.g. `scenedetect < 0.6`, `scenedetect < 0.7`, etc...).
 
 Creating a new scene detection method can be as simple as implementing the `process_frame` function, and optionally `post_process`:
 
@@ -63,7 +63,7 @@ class CustomDetector(SceneDetector):
 
 `process_frame` is called on every frame in the input video, which will be called after the final frame of the video is passed to `process_frame`. This may be useful for multi-pass algorithms, or detectors which are waiting on some condition but still wish to output an event on the final frame.
 
-For example, a detector may output at most 1 cuts for every call to `process_frame`, it may output the entire scene list in `post_process`, or a combination of both.  Note that the latter will not work in cases where a live video stream or camera input device is being used. See the [API documentation for the `SceneDetector` class](../docs/latest/api/detector.html#scenedetect.scene_detector.SceneDetector) for details. Alternatively, you can call `help(SceneDetector)` from a Python REPL. For examples of actual detection algorithm implementations, see the source files in the `scenedetect/detectors/` directory (e.g. `threshold_detector.py`, `content_detector.py`).
+For example, a detector may output at most 1 cuts for every call to `process_frame`, it may output the entire scene list in `post_process`, or a combination of both.  Note that the latter will not work in cases where a live video stream or camera input device is being used. See the [API documentation for the `SceneDetector` class](https://www.scenedetect.com/docs/latest/api/detector.html#scenedetect.scene_detector.SceneDetector) for details. Alternatively, you can call `help(SceneDetector)` from a Python REPL. For examples of actual detection algorithm implementations, see the source files in the `scenedetect/detectors/` directory (e.g. `threshold_detector.py`, `content_detector.py`).
 
 Processing is done by calling the `process_frame(...)` function for all frames in the video, followed by `post_process(...)` (optional) after the final frame.  Scene cuts are detected and added to the passed list object in both cases.
 
@@ -76,5 +76,5 @@ Processing is done by calling the `process_frame(...)` function for all frames i
 
 `post_process(...)` is called **after** the final frame has been processed, to allow for any stored scene cuts to be written *if required* (e.g. in the case of the `ThresholdDetector`).
 
-You may also want to look into the implementation of current detectors to understand how frame metrics are saved/loaded to/from a [`StatsManager`](../docs/latest/api/stats_manager.html) for caching and allowing values to be written to a stats file for users to graph and find trends in to tweak detector options.  Also see the documentation for the [`SceneManager`](../docs/latest/api/scene_manager.html) for details.
+You may also want to look into the implementation of current detectors to understand how frame metrics are saved/loaded to/from a [`StatsManager`](https://www.scenedetect.com/docs/latest/api/stats_manager.html) for caching and allowing values to be written to a stats file for users to graph and find trends in to tweak detector options.  Also see the documentation for the [`SceneManager`](https://www.scenedetect.com/docs/latest/api/scene_manager.html) for details.
 
diff --git a/website/pages/changelog.md b/website/pages/changelog.md
@@ -1,7 +1,5 @@
 
-Releases
-==========================================================
-
+# Releases
 
 ## PySceneDetect 0.7
 
diff --git a/website/pages/cli.md b/website/pages/cli.md
