Skip to content

Commit ab7752f

Browse files
yiitozeryiitozer
committed
API docs update
1 parent a58424d commit ab7752f

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+8300
-0
lines changed

‎docs/build/doctrees/environment.pickle

433 KB
Binary file not shown.

‎docs/build/doctrees/getting_started.doctree

4.03 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree

9.02 KB
Binary file not shown.

‎docs/build/doctrees/index_pitchshift.doctree

28 KB
Binary file not shown.

‎docs/build/doctrees/index_tsm.doctree

99.5 KB
Binary file not shown.

‎docs/build/doctrees/index_utils.doctree

129 KB
Binary file not shown.

‎docs/build/html/.buildinfo

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 333cbe205267b0df993670ab9c9c68af
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/_modules/index.html

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="en">
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Overview: module code &mdash; libtsm 1.1.1 documentation</title>
7+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
8+
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />
9+
10+
11+
<!--[if lt IE 9]>
12+
<script src="../_static/js/html5shiv.min.js"></script>
13+
<![endif]-->
14+
15+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=7a812f30"></script>
16+
<script src="../_static/doctools.js?v=888ff710"></script>
17+
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
18+
<script src="../_static/js/theme.js"></script>
19+
<link rel="index" title="Index" href="../genindex.html" />
20+
<link rel="search" title="Search" href="../search.html" />
21+
</head>
22+
23+
<body class="wy-body-for-nav">
24+
<div class="wy-grid-for-nav">
25+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
26+
<div class="wy-side-scroll">
27+
<div class="wy-side-nav-search" >
28+
29+
30+
31+
<a href="../index.html">
32+
33+
<img src="../_static/libtsm.png" class="logo" alt="Logo"/>
34+
</a>
35+
<div class="version">
36+
1.1.1
37+
</div>
38+
<div role="search">
39+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
40+
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
41+
<input type="hidden" name="check_keywords" value="yes" />
42+
<input type="hidden" name="area" value="default" />
43+
</form>
44+
</div>
45+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
46+
<ul>
47+
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
48+
</ul>
49+
<p class="caption" role="heading"><span class="caption-text">API Documentation</span></p>
50+
<ul>
51+
<li class="toctree-l1"><a class="reference internal" href="../index_tsm.html">Time-Scale Modification</a></li>
52+
<li class="toctree-l1"><a class="reference internal" href="../index_pitchshift.html">Pitch-Shifting</a></li>
53+
<li class="toctree-l1"><a class="reference internal" href="../index_utils.html">Utils</a></li>
54+
</ul>
55+
56+
</div>
57+
</div>
58+
</nav>
59+
60+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
61+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
62+
<a href="../index.html">libtsm</a>
63+
</nav>
64+
65+
<div class="wy-nav-content">
66+
<div class="rst-content">
67+
<div role="navigation" aria-label="Page navigation">
68+
<ul class="wy-breadcrumbs">
69+
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
70+
<li class="breadcrumb-item active">Overview: module code</li>
71+
<li class="wy-breadcrumbs-aside">
72+
</li>
73+
</ul>
74+
<hr/>
75+
</div>
76+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
77+
<div itemprop="articleBody">
78+
79+
<h1>All modules for which code is available</h1>
80+
<ul><li><a href="libtsm/pitchshift.html">libtsm.pitchshift</a></li>
81+
<li><a href="libtsm/tsm.html">libtsm.tsm</a></li>
82+
<li><a href="libtsm/utils.html">libtsm.utils</a></li>
83+
</ul>
84+
85+
</div>
86+
</div>
87+
<footer>
88+
89+
<hr/>
90+
91+
<div role="contentinfo">
92+
<p>&#169; Copyright 2021, Sebastian Rosenzweig, Simon Schwär, Jonathan Driedger, Meinard Müller.</p>
93+
</div>
94+
95+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
96+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
97+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
98+
99+
100+
</footer>
101+
</div>
102+
</div>
103+
</section>
104+
</div>
105+
<script>
106+
jQuery(function () {
107+
SphinxRtdTheme.Navigation.enable(true);
108+
});
109+
</script>
110+
111+
</body>
112+
</html>

‎docs/build/html/_modules/libtsm/pitchshift.html

+272
Large diffs are not rendered by default.

‎docs/build/html/_modules/libtsm/tsm.html

+617
Large diffs are not rendered by default.

‎docs/build/html/_modules/libtsm/utils.html

+728
Large diffs are not rendered by default.

‎docs/build/html/_sources/getting_started.rst.txt

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
Getting Started
2+
===============
3+
4+
Installation
5+
------------
6+
7+
With Python >= 3.6, you can install ``libtsm`` using the Python package manager pip:
8+
9+
.. code-block:: bash
10+
11+
pip install libtsm
12+
13+
Contributing
14+
------------
15+
16+
For development, testing, or generating the API documentation, clone the git repository and install:
17+
18+
.. code-block:: bash
19+
20+
git clone https://github.com/meinardmueller/libtsm.git
21+
cd libtsm
22+
pip install -e .[dev,tests,docs]

‎docs/build/html/_sources/index.rst.txt

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
.. libtsm documentation master file, created by
2+
sphinx-quickstart on Thu May 27 14:48:45 2021.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
libtsm
7+
==================================
8+
``libtsm`` is a Python toolbox for time-scale modification (TSM) and pitch-shifting.
9+
10+
Details and example application:
11+
12+
https://www.audiolabs-erlangen.de/resources/MIR/2021-DAFX-AdaptivePitchShifting
13+
14+
The toolbox is based on a re-implementation of the
15+
`Matlab TSM toolbox <https://www.audiolabs-erlangen.de/resources/MIR/TSMtoolbox/>`_ by Jonathan Driedger and Meinard Müller.
16+
17+
If you use this toolbox, please consider the following references:
18+
19+
.. [#] 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.
20+
21+
.. [#] 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.
22+
23+
.. [#] Jonathan Driedger and Meinard Müller: A Review on Time-Scale Modification of Music Signals. Applied Sciences, 6(2): 57–82, 2016.
24+
25+
.. [#] 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.
26+
27+
28+
.. toctree::
29+
:hidden:
30+
31+
getting_started
32+
33+
34+
35+
.. toctree::
36+
:caption: API Documentation
37+
:maxdepth: 1
38+
:hidden:
39+
40+
index_tsm
41+
index_pitchshift
42+
index_utils

‎docs/build/html/_sources/index_pitchshift.rst.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Pitch-Shifting
2+
==============
3+
4+
Functions for Pitch-Shifting
5+
6+
.. automodule:: libtsm.pitchshift
7+
:members:
8+
:undoc-members:

‎docs/build/html/_sources/index_tsm.rst.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Time-Scale Modification
2+
=======================
3+
4+
Functions for Time-Scale Modification
5+
6+
.. automodule:: libtsm.tsm
7+
:members:
8+
:undoc-members:

‎docs/build/html/_sources/index_utils.rst.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
Utils
2+
=====
3+
4+
Utility Functions
5+
6+
.. automodule:: libtsm.utils
7+
:members:
8+
:undoc-members:

0 commit comments

Comments
 (0)