Skip to content

Commit 8f38d67

Browse files
author
github-actions
committed
[docs] @Breakthrough: Generate Documentation
Source: main (1292cac) Destination: head
1 parent b10bf04 commit 8f38d67

9 files changed

Lines changed: 2 additions & 27 deletions

File tree

-1.69 KB
Binary file not shown.

docs/head/.doctrees/cli.doctree

-2.11 KB
Binary file not shown.
-5.31 KB
Binary file not shown.

docs/head/_sources/cli.rst.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,11 +178,7 @@ Options
178178

179179
Default: ``15.0``
180180

181-
.. option:: -d VAL, --min-delta-hsv VAL
182181

183-
[DEPRECATED] Use :option:`-c/--min-content-val <-c>` instead.
184-
185-
Default: ``15.0``
186182

187183
.. option:: -f VAL, --frame-window VAL
188184

docs/head/api/detectors.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@
6262
<p>This detector is available from the command-line as the <cite>detect-adaptive</cite> command.</p>
6363
<dl class="py class">
6464
<dt class="sig sig-object py" id="scenedetect.detectors.adaptive_detector.AdaptiveDetector">
65-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">scenedetect.detectors.adaptive_detector.</span></span><span class="sig-name descname"><span class="pre">AdaptiveDetector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adaptive_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_scene_len</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_content_val</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weights</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">Components(delta_hue=1.0,</span> <span class="pre">delta_sat=1.0,</span> <span class="pre">delta_lum=1.0,</span> <span class="pre">delta_edges=0.0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">luma_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_delta_hsv</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.detectors.adaptive_detector.AdaptiveDetector" title="Permalink to this definition"></a></dt>
65+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">scenedetect.detectors.adaptive_detector.</span></span><span class="sig-name descname"><span class="pre">AdaptiveDetector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">adaptive_threshold</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">3.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_scene_len</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">window_width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_content_val</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">15.0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">weights</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">Components(delta_hue=1.0,</span> <span class="pre">delta_sat=1.0,</span> <span class="pre">delta_lum=1.0,</span> <span class="pre">delta_edges=0.0)</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">luma_only</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">kernel_size</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#scenedetect.detectors.adaptive_detector.AdaptiveDetector" title="Permalink to this definition"></a></dt>
6666
<dd><p>Two-pass detector that calculates frame scores with ContentDetector, and then applies
6767
a rolling average when processing the result that can help mitigate false detections
6868
in situations such as camera movement.</p>
@@ -86,7 +86,6 @@
8686
Overrides <cite>weights</cite> if both are set.</p></li>
8787
<li><p><strong>kernel_size</strong> (<em>int</em><em> | </em><em>None</em>) – Size of kernel to use for post edge detection filtering. If None,
8888
automatically set based on video resolution.</p></li>
89-
<li><p><strong>min_delta_hsv</strong> (<em>float</em><em> | </em><em>None</em>) – [DEPRECATED] DO NOT USE. Use <cite>min_content_val</cite> instead.</p></li>
9089
</ul>
9190
</dd>
9291
</dl>

docs/head/cli.html

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -199,13 +199,6 @@ <h3>Options<a class="headerlink" href="#id2" title="Permalink to this heading">
199199
<p>Default: <code class="docutils literal notranslate"><span class="pre">15.0</span></code></p>
200200
</dd></dl>
201201

202-
<dl class="std option">
203-
<dt class="sig sig-object std" id="cmdoption-scenedetect-detect-adaptive-d">
204-
<span id="cmdoption-scenedetect-detect-adaptive-min-delta-hsv"></span><span class="sig-name descname"><span class="pre">-d</span></span><span class="sig-prename descclassname"> <span class="pre">VAL</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--min-delta-hsv</span></span><span class="sig-prename descclassname"> <span class="pre">VAL</span></span><a class="headerlink" href="#cmdoption-scenedetect-detect-adaptive-d" title="Permalink to this definition"></a></dt>
205-
<dd><p>[DEPRECATED] Use <a class="reference internal" href="#cmdoption-scenedetect-detect-adaptive-c"><code class="xref std std-option docutils literal notranslate"><span class="pre">-c/--min-content-val</span></code></a> instead.</p>
206-
<p>Default: <code class="docutils literal notranslate"><span class="pre">15.0</span></code></p>
207-
</dd></dl>
208-
209202
<dl class="std option">
210203
<dt class="sig sig-object std" id="cmdoption-scenedetect-detect-adaptive-f">
211204
<span id="cmdoption-scenedetect-detect-adaptive-frame-window"></span><span class="sig-name descname"><span class="pre">-f</span></span><span class="sig-prename descclassname"> <span class="pre">VAL</span></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--frame-window</span></span><span class="sig-prename descclassname"> <span class="pre">VAL</span></span><a class="headerlink" href="#cmdoption-scenedetect-detect-adaptive-f" title="Permalink to this definition"></a></dt>

docs/head/genindex.html

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -307,13 +307,6 @@ <h2 id="Symbols">Symbols</h2>
307307

308308
<ul>
309309
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-c">scenedetect-detect-adaptive command line option</a>
310-
</li>
311-
</ul></li>
312-
<li>
313-
--min-delta-hsv
314-
315-
<ul>
316-
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-d">scenedetect-detect-adaptive command line option</a>
317310
</li>
318311
</ul></li>
319312
<li>
@@ -586,8 +579,6 @@ <h2 id="Symbols">Symbols</h2>
586579

587580
<ul>
588581
<li><a href="cli.html#cmdoption-scenedetect-d">scenedetect command line option</a>
589-
</li>
590-
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-d">scenedetect-detect-adaptive command line option</a>
591582
</li>
592583
<li><a href="cli.html#cmdoption-scenedetect-save-qp-d">scenedetect-save-qp command line option</a>
593584
</li>
@@ -1441,8 +1432,6 @@ <h2 id="S">S</h2>
14411432
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-l">--luma-only</a>
14421433
</li>
14431434
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-c">--min-content-val</a>
1444-
</li>
1445-
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-d">--min-delta-hsv</a>
14461435
</li>
14471436
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-m">--min-scene-len</a>
14481437
</li>
@@ -1451,8 +1440,6 @@ <h2 id="S">S</h2>
14511440
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-w">--weights</a>
14521441
</li>
14531442
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-c">-c</a>
1454-
</li>
1455-
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-d">-d</a>
14561443
</li>
14571444
<li><a href="cli.html#cmdoption-scenedetect-detect-adaptive-f">-f</a>
14581445
</li>

docs/head/objects.inv

-17 Bytes
Binary file not shown.

docs/head/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)