Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
OrangeChannel committed Jul 29, 2020
1 parent 9f4ea0f commit 0d840c5
Show file tree
Hide file tree
Showing 11 changed files with 66 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
author = 'Dave <[email protected]>'

# The full version, including alpha/beta/rc tags
version = release = '5.0.0'
version = release = '5.0.1'


# -- General configuration ---------------------------------------------------
Expand Down
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: 093fab84becb6081857e479a12643e80
config: c487bba78c1919333c9d086c4c451323
tags: 645f666f9bcd5a90fca523b33c5a78b7
71 changes: 48 additions & 23 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.0.0 documentation</title>
<title>Overview: module code &mdash; acsuite 5.0.1 documentation</title>



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


<div class="version">
5.0.0
5.0.1
</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.0.0',
VERSION: '5.0.1',
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.0.0 documentation</title>
<title>Index &mdash; acsuite 5.0.1 documentation</title>



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


<div class="version">
5.0.0
5.0.1
</div>


Expand Down
10 changes: 6 additions & 4 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.0.0 documentation</title>
<title>acsuite documentation &mdash; acsuite 5.0.1 documentation</title>



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


<div class="version">
5.0.0
5.0.1
</div>


Expand Down Expand Up @@ -154,7 +154,7 @@
<h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
<span class="target" id="module-acsuite"></span><p>Frame-based cutting/trimming/splicing of audio with VapourSynth.</p>
<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>
Expand Down Expand Up @@ -191,7 +191,9 @@ <h1>acsuite documentation<a class="headerlink" href="#acsuite-documentation" tit
</div></blockquote>
</p></li>
<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
(i.e. ‘/path/to/audio_file.ext’).</p></li>
(i.e. ‘/path/to/audio_file.ext’).
If the extension is not recognized as a valid audio file extension for FFmpeg’s encoders,
the audio will be re-encoded to WAV losslessly.</p></li>
<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’
that will be used for the trimmed audio file.
The extension will be automatically inserted for you,
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.0.0 documentation</title>
<title>Python Module Index &mdash; acsuite 5.0.1 documentation</title>



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


<div class="version">
5.0.0
5.0.1
</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.0.0 documentation</title>
<title>Search &mdash; acsuite 5.0.1 documentation</title>



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


<div class="version">
5.0.0
5.0.1
</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 0d840c5

Please sign in to comment.