Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
OrangeChannel committed Aug 10, 2020
1 parent 4100a93 commit c4500aa
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 8083ae105364b70c5322521fb0238a67
config: e1a4d8a52e5165c4be5c44f8bc7ae4d8
tags: 645f666f9bcd5a90fca523b33c5a78b7
41 changes: 29 additions & 12 deletions docs/html/_modules/acsuite.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Overview: module code &mdash; acsuite 5.1.0 documentation</title>
<title>Overview: module code &mdash; acsuite 5.2.0 documentation</title>



Expand Down Expand Up @@ -59,7 +59,7 @@


<div class="version">
5.1.0
5.2.0
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: '5.1.0',
VERSION: '5.2.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions docs/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Index &mdash; acsuite 5.1.0 documentation</title>
<title>Index &mdash; acsuite 5.2.0 documentation</title>



Expand Down Expand Up @@ -59,7 +59,7 @@


<div class="version">
5.1.0
5.2.0
</div>


Expand Down
8 changes: 5 additions & 3 deletions docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>acsuite documentation &mdash; acsuite 5.1.0 documentation</title>
<title>acsuite documentation &mdash; acsuite 5.2.0 documentation</title>



Expand Down Expand Up @@ -59,7 +59,7 @@


<div class="version">
5.1.0
5.2.0
</div>


Expand Down Expand Up @@ -157,7 +157,7 @@ <h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" tit
<span class="target" id="module-acsuite"></span><p>Frame-based cutting/trimming/splicing of audio with VapourSynth and FFmpeg.</p>
<dl class="py function">
<dt id="acsuite.eztrim">
<code class="sig-prename descclassname">acsuite.</code><code class="sig-name descname">eztrim</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clip</span></em>, <em class="sig-param"><span class="n">trims</span></em>, <em class="sig-param"><span class="n">audio_file</span></em>, <em class="sig-param"><span class="n">outfile</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">ffmpeg_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/acsuite.html#eztrim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#acsuite.eztrim" title="Permalink to this definition"></a></dt>
<code class="sig-prename descclassname">acsuite.</code><code class="sig-name descname">eztrim</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">clip</span></em>, <em class="sig-param"><span class="n">trims</span></em>, <em class="sig-param"><span class="n">audio_file</span></em>, <em class="sig-param"><span class="n">outfile</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">*</span></em>, <em class="sig-param"><span class="n">ffmpeg_path</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">quiet</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">timecodes_file</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/acsuite.html#eztrim"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#acsuite.eztrim" title="Permalink to this definition"></a></dt>
<dd><p>Simple trimming function that follows VapourSynth/Python slicing syntax.</p>
<p>End frame is NOT inclusive.</p>
<p>For a 100 frame long VapourSynth clip:</p>
Expand Down Expand Up @@ -202,6 +202,8 @@ <h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" tit
<li><p><strong>ffmpeg_path</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PathLike</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code>]) – Set this if <code class="docutils literal notranslate"><span class="pre">ffmpeg</span></code> is not in your <cite>PATH</cite>.
If <code class="docutils literal notranslate"><span class="pre">ffmpeg</span></code> exists in your <cite>PATH</cite>, it will automatically be detected and used.</p></li>
<li><p><strong>quiet</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Suppresses most console output from FFmpeg</p></li>
<li><p><strong>timecodes_file</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">PathLike</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">Path</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code>]) – Timecodes v2 file (generated by vspipe, ffms2, etc.) for variable-frame-rate clips.
Not needed for CFR clips.</p></li>
<li><p><strong>debug</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>) – Used for testing purposes</p></li>
</ul>
</dd>
Expand Down
Binary file modified docs/html/objects.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/html/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Python Module Index &mdash; acsuite 5.1.0 documentation</title>
<title>Python Module Index &mdash; acsuite 5.2.0 documentation</title>



Expand Down Expand Up @@ -66,7 +66,7 @@


<div class="version">
5.1.0
5.2.0
</div>


Expand Down
4 changes: 2 additions & 2 deletions docs/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Search &mdash; acsuite 5.1.0 documentation</title>
<title>Search &mdash; acsuite 5.2.0 documentation</title>



Expand Down Expand Up @@ -60,7 +60,7 @@


<div class="version">
5.1.0
5.2.0
</div>


Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit c4500aa

Please sign in to comment.