Skip to content

Commit f4dcb8d

Browse files
author
github-actions
committed
[docs] @Breakthrough: Generate Documentation
Source: main (3aabe15) Destination: head
1 parent 2b89c73 commit f4dcb8d

26 files changed

Lines changed: 108 additions & 346 deletions

‎docs/head/.doctrees/api.doctree‎

707 Bytes
Binary file not shown.

‎docs/head/.doctrees/api/output.doctree‎

-98.8 KB
Binary file not shown.

‎docs/head/.doctrees/environment.pickle‎

-137 KB
Binary file not shown.

‎docs/head/_sources/api.rst.txt‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
99

1010
* :ref:`scenedetect.detectors 🕵️ <scenedetect-detectors>`: detection algorithms:
1111

12-
* :mod:`AdaptiveDetector <scenedetect.detectors.adaptive_detector>` finds fast cuts using rolling average of HSL changes
12+
* :class:`AdaptiveDetector <scenedetect.detectors.adaptive_detector.AdaptiveDetector>`: finds fast cuts using rolling average of HSL changes
1313

14-
* :mod:`ContentDetector <scenedetect.detectors.content_detector>`: detects fast cuts using weighted average of HSV changes
14+
* :class:`ContentDetector <scenedetect.detectors.content_detector.ContentDetector>`: detects fast cuts using weighted average of HSV changes
1515

16-
* :mod:`ThresholdDetector <scenedetect.detectors.threshold_detector>`: finds fades in/out using average pixel intensity changes in RGB
16+
* :class:`ThresholdDetector <scenedetect.detectors.threshold_detector.ThresholdDetector>`: finds fades in/out using average pixel intensity changes in RGB
1717

18-
* :mod:`HistogramDetector <scenedetect.detectors.histogram_detector>` finds fast cuts using HSV histogram changes
18+
* :class:`HistogramDetector <scenedetect.detectors.histogram_detector.HistogramDetector>`: finds fast cuts using HSV histogram changes
1919

20-
* :mod:`HashDetector <scenedetect.detectors.hash_detector>`: finds fast cuts using perceptual image hashing
20+
* :class:`HashDetector <scenedetect.detectors.hash_detector.HashDetector>`: finds fast cuts using perceptual image hashing
2121

2222
* :ref:`scenedetect.output ✂️ <scenedetect-output>`: Output formats:
2323

@@ -41,7 +41,7 @@ The `scenedetect` API is easy to integrate with most application workflows, whil
4141

4242
* :ref:`scenedetect.detector 🌐 <scenedetect-detector>`: the interface (:class:`SceneDetector <scenedetect.detector.SceneDetector>`) that detectors must implement to be compatible with PySceneDetect
4343

44-
* :ref:`scenedetect.video_stream <scenedetect-video_stream>`: the interface (:class:`VideoStream <scenedetect.video_stream.VideoStream>`) that detectors must implement to be compatible with PySceneDetect
44+
* :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
4545

4646
* :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
4747

‎docs/head/_sources/api/backends.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
.. _scenedetect-backends:
33

4-
----------------------------------------
4+
--------------
55
Video Backends
6-
----------------------------------------
6+
--------------
77

88
.. automodule:: scenedetect.backends
99
:members:

‎docs/head/_sources/api/common.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
.. _scenedetect-common:
33

4-
---------------------------------------------------------------
4+
------
55
Common
6-
---------------------------------------------------------------
6+
------
77

88
.. automodule:: scenedetect.common
99
:members:

‎docs/head/_sources/api/detector.rst.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
.. _scenedetect-detector:
33

4-
-------------------------------------------------
4+
------------------
55
Detector Interface
6-
-------------------------------------------------
6+
------------------
77

88
.. automodule:: scenedetect.detector
99
:members:

‎docs/head/_sources/api/detectors.rst.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11

22
.. _scenedetect-detectors:
33

4-
----------------------------------------
4+
---------
55
Detectors
6-
----------------------------------------
6+
---------
77

88
.. automodule:: scenedetect.detectors
99

1010
AdaptiveDetector
11-
========================================
11+
================
1212

1313
.. automodule:: scenedetect.detectors.adaptive_detector
1414
:no-members:
@@ -17,7 +17,7 @@ AdaptiveDetector
1717
:members:
1818

1919
ContentDetector
20-
========================================
20+
===============
2121

2222
.. automodule:: scenedetect.detectors.content_detector
2323
:no-members:
@@ -26,7 +26,7 @@ ContentDetector
2626
:members:
2727

2828
HashDetector
29-
========================================
29+
============
3030

3131
.. automodule:: scenedetect.detectors.hash_detector
3232
:no-members:
@@ -35,7 +35,7 @@ HashDetector
3535
:members:
3636

3737
HistogramDetector
38-
========================================
38+
=================
3939

4040
.. automodule:: scenedetect.detectors.histogram_detector
4141
:no-members:
@@ -44,7 +44,7 @@ HistogramDetector
4444
:members:
4545

4646
ThresholdDetector
47-
========================================
47+
=================
4848

4949
.. automodule:: scenedetect.detectors.threshold_detector
5050
:no-members:

‎docs/head/_sources/api/output.rst.txt‎

Lines changed: 2 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,9 @@
11

2-
32
.. _scenedetect-output:
43

54
------
65
Output
76
------
87

9-
.. autofunction:: scenedetect.output.save_images
10-
11-
.. autofunction:: scenedetect.output.is_ffmpeg_available
12-
13-
.. autofunction:: scenedetect.output.split_video_ffmpeg
14-
15-
.. autofunction:: scenedetect.output.is_mkvmerge_available
16-
17-
.. autofunction:: scenedetect.output.split_video_mkvmerge
18-
19-
.. autofunction:: scenedetect.output.write_scene_list_html
20-
21-
.. autofunction:: scenedetect.output.write_scene_list
22-
23-
.. autofunction:: scenedetect.output.write_scene_list_edl
24-
25-
.. autofunction:: scenedetect.output.write_scene_list_fcpx
26-
27-
.. autofunction:: scenedetect.output.write_scene_list_fcp7
28-
29-
.. autofunction:: scenedetect.output.write_scene_list_otio
30-
31-
.. autoclass:: scenedetect.output.SceneMetadata
32-
33-
.. autoclass:: scenedetect.output.VideoMetadata
34-
35-
.. autofunction:: scenedetect.output.default_formatter
36-
8+
.. automodule:: scenedetect.output
9+
:members:

‎docs/head/_sources/api/platform.rst.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11

22
.. _scenedetect-platform:
33

4-
---------------------------------------------------------------
4+
------------------
55
Platform & Logging
6-
---------------------------------------------------------------
6+
------------------
77

88
.. automodule:: scenedetect.platform
9-
:members:
9+
:members:

0 commit comments

Comments
 (0)