[docs] @Breakthrough: Generate Documentation

Source: main (7fce841)

Destination: head

Author: github-actions

docs/head/.doctrees/api/migration_guide.doctree

@@ -203,4 +203,4 @@ CLI Changes
 
 - The ``-d``/``--min-delta-hsv`` option on ``detect-adaptive`` has been removed. Use ``-c``/``--min-content-val`` instead.
 - VFR videos now work correctly with both the OpenCV and PyAV backends.
-- New ``save-xml`` command for exporting scenes in Final Cut Pro XML format.
+- New ``save-fcp`` command for exporting scenes in Final Cut Pro XML format.

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

@@ -20,6 +20,14 @@ Ouptut
 
 .. 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

docs/head/.doctrees/cli.doctree

@@ -178,8 +178,6 @@ Options
 
   Default: ``15.0``
 
-
-
 .. option:: -f VAL, --frame-window VAL
 
   Size of window to detect deviations from mean. Represents how many frames before/after the current one to use for mean.
@@ -552,6 +550,38 @@ Options
   Output directory to save EDL file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
 
 
+.. _command-save-fcp:
+
+.. program:: scenedetect save-fcp
+
+
+``save-fcp``
+========================================================================
+
+Save cuts in Final Cut Pro XML format (FCP7 xmeml or FCPX).
+
+
+Options
+------------------------------------------------------------------------
+
+
+.. option:: -f NAME, --filename NAME
+
+  Filename format to use.
+
+  Default: ``$VIDEO_NAME.xml``
+
+.. option:: --format TYPE
+
+  Format to export. TYPE must be one of: fcpx, fcp7.
+
+  Default: ``FcpFormat.FCPX``
+
+.. option:: -o DIR, --output DIR
+
+  Output directory to save XML file to. Overrides global option :option:`-o/--output <scenedetect -o>`.
+
+
 .. _command-save-html:
 
 .. program:: scenedetect save-html
@@ -658,11 +688,11 @@ Options
 
   Default: ``3``
 
-.. option:: -m N, --frame-margin N
+.. option:: -m DURATION, --frame-margin DURATION
 
-  Number of frames to ignore at beginning/end of scenes when saving images. Controls temporal padding on scene boundaries.
+  Padding around the beginning/end of each scene used when selecting which frames to extract. DURATION can be specified in frames (-m 1), in seconds with `s` suffix (-m 0.1s), or timecode (-m 00:00:00.100).
 
-  Default: ``3``
+  Default: ``1``
 
 .. option:: -s S, --scale S
 

docs/head/.doctrees/cli/config_file.doctree

@@ -317,6 +317,10 @@ <h2>Module Reference<a class="headerlink" href="#module-reference" title="Permal
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.split_video_mkvmerge"><code class="docutils literal notranslate"><span class="pre">split_video_mkvmerge()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list_html"><code class="docutils literal notranslate"><span class="pre">write_scene_list_html()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list"><code class="docutils literal notranslate"><span class="pre">write_scene_list()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list_edl"><code class="docutils literal notranslate"><span class="pre">write_scene_list_edl()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list_fcpx"><code class="docutils literal notranslate"><span class="pre">write_scene_list_fcpx()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list_fcp7"><code class="docutils literal notranslate"><span class="pre">write_scene_list_fcp7()</span></code></a></li>
+<li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.write_scene_list_otio"><code class="docutils literal notranslate"><span class="pre">write_scene_list_otio()</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.SceneMetadata"><code class="docutils literal notranslate"><span class="pre">SceneMetadata</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.VideoMetadata"><code class="docutils literal notranslate"><span class="pre">VideoMetadata</span></code></a></li>
 <li class="toctree-l2"><a class="reference internal" href="api/output.html#scenedetect.output.default_formatter"><code class="docutils literal notranslate"><span class="pre">default_formatter()</span></code></a></li>

docs/head/.doctrees/environment.pickle

@@ -226,7 +226,7 @@ <h2>CLI Changes<a class="headerlink" href="#cli-changes" title="Permalink to thi
 <ul class="simple">
 <li><p>The <code class="docutils literal notranslate"><span class="pre">-d</span></code>/<code class="docutils literal notranslate"><span class="pre">--min-delta-hsv</span></code> option on <code class="docutils literal notranslate"><span class="pre">detect-adaptive</span></code> has been removed. Use <code class="docutils literal notranslate"><span class="pre">-c</span></code>/<code class="docutils literal notranslate"><span class="pre">--min-content-val</span></code> instead.</p></li>
 <li><p>VFR videos now work correctly with both the OpenCV and PyAV backends.</p></li>
-<li><p>New <code class="docutils literal notranslate"><span class="pre">save-xml</span></code> command for exporting scenes in Final Cut Pro XML format.</p></li>
+<li><p>New <code class="docutils literal notranslate"><span class="pre">save-fcp</span></code> command for exporting scenes in Final Cut Pro XML format.</p></li>
 </ul>
 </section>
 </section>