deploy: 4ee1dba

audeering · Dec 13, 2023 · ea80727 · ea80727
1 parent addef8a
commit ea80727
Show file tree

Hide file tree

Showing 34 changed files with 101 additions and 81 deletions.
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/contributing.doctree b/.doctrees/contributing.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/_images/usage_10_0.png b/_images/usage_10_0.png
diff --git a/_images/usage_12_0.png b/_images/usage_12_0.png
diff --git a/_images/usage_14_0.png b/_images/usage_14_0.png
diff --git a/_images/usage_2_0.png b/_images/usage_2_0.png
diff --git a/_images/usage_4_0.png b/_images/usage_4_0.png
diff --git a/_images/usage_6_0.png b/_images/usage_6_0.png
diff --git a/_images/usage_8_0.png b/_images/usage_8_0.png
diff --git a/_modules/audresample/core/api.html b/_modules/audresample/core/api.html
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -387,7 +387,7 @@ <h1>Source code for audresample.core.api</h1><div class="highlight"><pre>
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/_modules/audresample/core/config.html b/_modules/audresample/core/config.html
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -164,7 +164,7 @@ <h1>Source code for audresample.core.config</h1><div class="highlight"><pre>
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/_modules/audresample/core/define.html b/_modules/audresample/core/define.html
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -164,7 +164,7 @@ <h1>Source code for audresample.core.define</h1><div class="highlight"><pre>
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/_modules/index.html b/_modules/index.html
@@ -66,7 +66,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -159,7 +159,7 @@ <h1>All modules for which code is available</h1>
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -1,5 +1,3 @@
-.. documentation master file
-
 .. include:: ../README.rst
 
 .. toctree::

diff --git a/_static/pygments.css b/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #FF0000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */

diff --git a/api/audresample.am_fm_synth.html b/api/audresample.am_fm_synth.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -159,14 +159,14 @@ <h1>am_fm_synth()<a class="headerlink" href="#am-fm-synth" title="Permalink to t
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>num_samples</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – number of samples</p></li>
-<li><p><strong>num_channels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – number of channels in the output signal</p></li>
-<li><p><strong>sampling_rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – sampling rate in Hz</p></li>
+<li><p><strong>num_samples</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – number of samples</p></li>
+<li><p><strong>num_channels</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – number of channels in the output signal</p></li>
+<li><p><strong>sampling_rate</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>) – sampling rate in Hz</p></li>
 <li><p><strong>dtype</strong> – data type</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type</dt>
-<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a></p>
+<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a></p>
 </dd>
 <dt class="field-odd">Returns</dt>
 <dd class="field-odd"><p>signal with shape <code class="docutils literal notranslate"><span class="pre">(number</span> <span class="pre">of</span> <span class="pre">channels,</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">samples)</span></code></p>
@@ -199,7 +199,7 @@ <h1>am_fm_synth()<a class="headerlink" href="#am-fm-synth" title="Permalink to t
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/api/audresample.config.html b/api/audresample.config.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -194,7 +194,7 @@ <h2>DEFAULT_RESAMPLE_QUALITY<a class="headerlink" href="#default-resample-qualit
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/api/audresample.define.ResampleQuality.html b/api/audresample.define.ResampleQuality.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -227,7 +227,7 @@ <h2>VERY_HIGH<a class="headerlink" href="#very-high" title="Permalink to this he
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/api/audresample.define.html b/api/audresample.define.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -184,7 +184,7 @@
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/api/audresample.html b/api/audresample.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -196,7 +196,7 @@
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>

diff --git a/api/audresample.remix.html b/api/audresample.remix.html
@@ -68,7 +68,7 @@
 
 
               <div class="version">
-                v1.3.2
+                v1.3.3
               </div>
 
 
@@ -211,25 +211,25 @@ <h1>remix()<a class="headerlink" href="#remix" title="Permalink to this heading"
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
-<li><p><strong>signal</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – array with signal values</p></li>
-<li><p><strong>channels</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]) – channel selection, see description</p></li>
-<li><p><strong>mixdown</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – apply mono mix-down on selection</p></li>
-<li><p><strong>upmix</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – if <code class="docutils literal notranslate"><span class="pre">'zeros'</span></code> it will pad missing channels with zeros,
+<li><p><strong>signal</strong> (<a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a>) – array with signal values</p></li>
+<li><p><strong>channels</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Union" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Sequence" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Sequence</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>], <a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></a>]) – channel selection, see description</p></li>
+<li><p><strong>mixdown</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – apply mono mix-down on selection</p></li>
+<li><p><strong>upmix</strong> (<a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>]) – if <code class="docutils literal notranslate"><span class="pre">'zeros'</span></code> it will pad missing channels with zeros,
 if <code class="docutils literal notranslate"><span class="pre">'repeat'</span></code> it will pad by repeating the existing channels</p></li>
-<li><p><strong>always_copy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – if <code class="docutils literal notranslate"><span class="pre">True</span></code> always returns a new object</p></li>
+<li><p><strong>always_copy</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></a>) – if <code class="docutils literal notranslate"><span class="pre">True</span></code> always returns a new object</p></li>
 </ul>
 </dd>
 <dt class="field-even">Return type</dt>
-<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.24)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a></p>
+<dd class="field-even"><p><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v1.26)"><code class="xref py py-class docutils literal notranslate"><span class="pre">ndarray</span></code></a></p>
 </dd>
 <dt class="field-odd">Returns</dt>
 <dd class="field-odd"><p>remixed signal with shape <code class="docutils literal notranslate"><span class="pre">(number</span> <span class="pre">of</span> <span class="pre">channels,</span> <span class="pre">number</span> <span class="pre">of</span> <span class="pre">samples)</span></code></p>
 </dd>
 <dt class="field-even">Raises</dt>
 <dd class="field-even"><ul class="simple">
-<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – if input signal has more than two dimensions</p></li>
-<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – if channel selection is invalid and upmix is <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
-<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.11)"><strong>ValueError</strong></a> – if specified upmix method is not known</p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.12)"><strong>RuntimeError</strong></a> – if input signal has more than two dimensions</p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – if channel selection is invalid and upmix is <code class="docutils literal notranslate"><span class="pre">None</span></code></p></li>
+<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.12)"><strong>ValueError</strong></a> – if specified upmix method is not known</p></li>
 </ul>
 </dd>
 </dl>
@@ -260,7 +260,7 @@ <h1>remix()<a class="headerlink" href="#remix" title="Permalink to this heading"
 
 
 
-          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+          Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
 
     </p>
   </div>
-Original file line number
+Diff line change
@@ Expand Up / @@ -66,7 +66,7 @@ @@
                   <div class="version">
-                    v1.3.2
+                    v1.3.3
                   </div>
@@ Expand Down Expand Up @@
-              Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/05/30 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
+              Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/12/13 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
         </p>
       </div>
@@ Expand Down @@