Skip to content

Commit 0d840c5

Browse files
OrangeChannelOrangeChannel
committed
Update documentation
1 parent 9f4ea0f commit 0d840c5

11 files changed

Lines changed: 66 additions & 39 deletions

File tree

‎docs/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
author = 'Dave <orangechannel@pm.me>'
2323

2424
# The full version, including alpha/beta/rc tags
25-
version = release = '5.0.0'
25+
version = release = '5.0.1'
2626

2727

2828
# -- General configuration ---------------------------------------------------

‎docs/html/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 093fab84becb6081857e479a12643e80
3+
config: c487bba78c1919333c9d086c4c451323
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/html/_modules/acsuite.html‎

Lines changed: 48 additions & 23 deletions
Large diffs are not rendered by default.

‎docs/html/_modules/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
<title>Overview: module code &mdash; acsuite 5.0.0 documentation</title>
11+
<title>Overview: module code &mdash; acsuite 5.0.1 documentation</title>
1212

1313

1414

@@ -59,7 +59,7 @@
5959

6060

6161
<div class="version">
62-
5.0.0
62+
5.0.1
6363
</div>
6464

6565

‎docs/html/_static/documentation_options.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '5.0.0',
3+
VERSION: '5.0.1',
44
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

‎docs/html/genindex.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
<title>Index &mdash; acsuite 5.0.0 documentation</title>
11+
<title>Index &mdash; acsuite 5.0.1 documentation</title>
1212

1313

1414

@@ -59,7 +59,7 @@
5959

6060

6161
<div class="version">
62-
5.0.0
62+
5.0.1
6363
</div>
6464

6565

‎docs/html/index.html‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
<title>acsuite documentation &mdash; acsuite 5.0.0 documentation</title>
11+
<title>acsuite documentation &mdash; acsuite 5.0.1 documentation</title>
1212

1313

1414

@@ -59,7 +59,7 @@
5959

6060

6161
<div class="version">
62-
5.0.0
62+
5.0.1
6363
</div>
6464

6565

@@ -154,7 +154,7 @@
154154
<h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" title="Permalink to this headline"></a></h1>
155155
<div class="toctree-wrapper compound">
156156
</div>
157-
<span class="target" id="module-acsuite"></span><p>Frame-based cutting/trimming/splicing of audio with VapourSynth.</p>
157+
<span class="target" id="module-acsuite"></span><p>Frame-based cutting/trimming/splicing of audio with VapourSynth and FFmpeg.</p>
158158
<dl class="py function">
159159
<dt id="acsuite.eztrim">
160160
<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>
@@ -191,7 +191,9 @@ <h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" tit
191191
</div></blockquote>
192192
</p></li>
193193
<li><p><strong>audio_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>]) – A string or path-like object refering to the source audio file’s location
194-
(i.e. ‘/path/to/audio_file.ext’).</p></li>
194+
(i.e. ‘/path/to/audio_file.ext’).
195+
If the extension is not recognized as a valid audio file extension for FFmpeg’s encoders,
196+
the audio will be re-encoded to WAV losslessly.</p></li>
195197
<li><p><strong>outfile</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>]) – Either a filename ‘out.ext’ or a full path ‘/path/to/out.ext’
196198
that will be used for the trimmed audio file.
197199
The extension will be automatically inserted for you,

‎docs/html/objects.inv‎

0 Bytes
Binary file not shown.

‎docs/html/py-modindex.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
<title>Python Module Index &mdash; acsuite 5.0.0 documentation</title>
11+
<title>Python Module Index &mdash; acsuite 5.0.1 documentation</title>
1212

1313

1414

@@ -66,7 +66,7 @@
6666

6767

6868
<div class="version">
69-
5.0.0
69+
5.0.1
7070
</div>
7171

7272

‎docs/html/search.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
<title>Search &mdash; acsuite 5.0.0 documentation</title>
11+
<title>Search &mdash; acsuite 5.0.1 documentation</title>
1212

1313

1414

@@ -60,7 +60,7 @@
6060

6161

6262
<div class="version">
63-
5.0.0
63+
5.0.1
6464
</div>
6565

6666

0 commit comments

Comments
 (0)