API docs update

meinardmueller · May 22, 2024 · ab7752f · ab7752f
1 parent a58424d
commit ab7752f
Show file tree

Hide file tree

Showing 60 changed files with 8,300 additions and 0 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/getting_started.doctree b/docs/build/doctrees/getting_started.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/index_pitchshift.doctree b/docs/build/doctrees/index_pitchshift.doctree
diff --git a/docs/build/doctrees/index_tsm.doctree b/docs/build/doctrees/index_tsm.doctree
diff --git a/docs/build/doctrees/index_utils.doctree b/docs/build/doctrees/index_utils.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +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: 333cbe205267b0df993670ab9c9c68af
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -0,0 +1,112 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>Overview: module code &mdash; libtsm 1.1.1 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
+      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=7a812f30"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=4825356b"></script>
+    <script src="../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../index.html">
+
+              <img src="../_static/libtsm.png" class="logo" alt="Logo"/>
+          </a>
+              <div class="version">
+                1.1.1
+              </div>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <ul>
+<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../index_tsm.html">Time-Scale Modification</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_pitchshift.html">Pitch-Shifting</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../index_utils.html">Utils</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../index.html">libtsm</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>All modules for which code is available</h1>
+<ul><li><a href="libtsm/pitchshift.html">libtsm.pitchshift</a></li>
+<li><a href="libtsm/tsm.html">libtsm.tsm</a></li>
+<li><a href="libtsm/utils.html">libtsm.utils</a></li>
+</ul>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2021, Sebastian Rosenzweig, Simon Schwär, Jonathan Driedger, Meinard Müller.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/docs/build/html/_modules/libtsm/pitchshift.html b/docs/build/html/_modules/libtsm/pitchshift.html
diff --git a/docs/build/html/_modules/libtsm/tsm.html b/docs/build/html/_modules/libtsm/tsm.html
diff --git a/docs/build/html/_modules/libtsm/utils.html b/docs/build/html/_modules/libtsm/utils.html
diff --git a/docs/build/html/_sources/getting_started.rst.txt b/docs/build/html/_sources/getting_started.rst.txt
@@ -0,0 +1,22 @@
+Getting Started
+===============
+
+Installation
+------------
+
+With Python >= 3.6, you can install ``libtsm`` using the Python package manager pip:
+
+.. code-block:: bash
+
+  pip install libtsm
+
+Contributing
+------------
+
+For development, testing, or generating the API documentation, clone the git repository and install:
+
+.. code-block:: bash
+
+    git clone https://github.com/meinardmueller/libtsm.git
+    cd libtsm
+    pip install -e .[dev,tests,docs]
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -0,0 +1,42 @@
+.. libtsm documentation master file, created by
+   sphinx-quickstart on Thu May 27 14:48:45 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+libtsm
+==================================
+``libtsm`` is a Python toolbox for time-scale modification (TSM) and pitch-shifting.
+
+Details and example application:
+
+https://www.audiolabs-erlangen.de/resources/MIR/2021-DAFX-AdaptivePitchShifting
+
+The toolbox is based on a re-implementation of the
+`Matlab TSM toolbox <https://www.audiolabs-erlangen.de/resources/MIR/TSMtoolbox/>`_ by Jonathan Driedger and Meinard Müller.
+
+If you use this toolbox, please consider the following references:
+
+.. [#] Sebastian Rosenzweig, Simon Schwär, Jonathan Driedger, and Meinard Müller: Adaptive Pitch-Shifting with Applications to Intonation Adjustment in A Cappella Recordings, Proceedings of the International Conference on Digital Audio Effects (DAFx), 2021.
+
+.. [#] Jonathan Driedger and Meinard Müller: TSM Toolbox: MATLAB Implementations of Time-Scale Modification Algorithms. In Proceedings of the International Conference on Digital Audio Effects (DAFx): 249–256, 2014.
+
+.. [#] Jonathan Driedger and Meinard Müller: A Review on Time-Scale Modification of Music Signals. Applied Sciences, 6(2): 57–82, 2016.
+
+.. [#] Jonathan Driedger, Meinard Müller, and Sebastian Ewert: Improving Time-Scale Modification of Music Signals using Harmonic-Percussive Separation. IEEE Signal Processing Letters, 21(1): 105–109, 2014.
+
+
+.. toctree::
+    :hidden:
+
+    getting_started
+
+
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+    :hidden:
+
+    index_tsm
+    index_pitchshift
+    index_utils
diff --git a/docs/build/html/_sources/index_pitchshift.rst.txt b/docs/build/html/_sources/index_pitchshift.rst.txt
@@ -0,0 +1,8 @@
+Pitch-Shifting
+==============
+
+Functions for Pitch-Shifting
+
+.. automodule:: libtsm.pitchshift
+    :members:
+    :undoc-members:
diff --git a/docs/build/html/_sources/index_tsm.rst.txt b/docs/build/html/_sources/index_tsm.rst.txt
@@ -0,0 +1,8 @@
+Time-Scale Modification
+=======================
+
+Functions for Time-Scale Modification
+
+.. automodule:: libtsm.tsm
+    :members:
+    :undoc-members:
diff --git a/docs/build/html/_sources/index_utils.rst.txt b/docs/build/html/_sources/index_utils.rst.txt
@@ -0,0 +1,8 @@
+Utils
+=====
+
+Utility Functions
+
+.. automodule:: libtsm.utils
+    :members:
+    :undoc-members: