Skip to content

Commit f75d3ca

Browse files
fzalkowfzalkow
committed
API documentation
1 parent f87d4f9 commit f75d3ca

File tree

184 files changed

+51540
-0
lines changed

Some content is hidden

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

184 files changed

+51540
-0
lines changed

‎.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55
build/
66
dist/
77
libfmp.egg-info/
8+
9+
# do not ignore build of docs
10+
!docs/build/

‎docs/Makefile

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = source
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/build/.gitkeep

Whitespace-only changes.

‎docs/build/doctrees/environment.pickle

437 KB
Binary file not shown.

‎docs/build/doctrees/genindex.doctree

2.21 KB
Binary file not shown.

‎docs/build/doctrees/getting_started.doctree

4.21 KB
Binary file not shown.

‎docs/build/doctrees/index.doctree

6.32 KB
Binary file not shown.

‎docs/build/doctrees/index_b.doctree

257 KB
Binary file not shown.

‎docs/build/doctrees/index_c1.doctree

175 KB
Binary file not shown.

‎docs/build/doctrees/index_c2.doctree

187 KB
Binary file not shown.

‎docs/build/doctrees/index_c3.doctree

187 KB
Binary file not shown.

‎docs/build/doctrees/index_c4.doctree

363 KB
Binary file not shown.

‎docs/build/doctrees/index_c5.doctree

175 KB
Binary file not shown.

‎docs/build/doctrees/index_c6.doctree

276 KB
Binary file not shown.

‎docs/build/doctrees/index_c7.doctree

220 KB
Binary file not shown.

‎docs/build/doctrees/index_c8.doctree

342 KB
Binary file not shown.

‎docs/build/doctrees/py-modindex.doctree

2.24 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: ae132c943bae29b527a4e49860516f8c
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

+266
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,266 @@
1+
2+
3+
<!DOCTYPE html>
4+
<html class="writer-html5" lang="en" >
5+
<head>
6+
<meta charset="utf-8" />
7+
8+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9+
10+
<title>Overview: module code &mdash; libfmp 1.1.1 documentation</title>
11+
12+
13+
14+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
15+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
16+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
17+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
18+
19+
20+
21+
22+
23+
24+
25+
26+
27+
28+
<!--[if lt IE 9]>
29+
<script src="../_static/js/html5shiv.min.js"></script>
30+
<![endif]-->
31+
32+
33+
<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
34+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
35+
<script src="../_static/jquery.js"></script>
36+
<script src="../_static/underscore.js"></script>
37+
<script src="../_static/doctools.js"></script>
38+
39+
<script type="text/javascript" src="../_static/js/theme.js"></script>
40+
41+
42+
<link rel="index" title="Index" href="../genindex.html" />
43+
<link rel="search" title="Search" href="../search.html" />
44+
</head>
45+
46+
<body class="wy-body-for-nav">
47+
48+
49+
<div class="wy-grid-for-nav">
50+
51+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
52+
<div class="wy-side-scroll">
53+
<div class="wy-side-nav-search" >
54+
55+
56+
57+
<a href="../index.html">
58+
59+
60+
61+
62+
<img src="../_static/Logo_libfmp.png" class="logo" alt="Logo"/>
63+
64+
</a>
65+
66+
67+
68+
69+
<div class="version">
70+
1.1.1
71+
</div>
72+
73+
74+
75+
76+
<div role="search">
77+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
78+
<input type="text" name="q" placeholder="Search docs" />
79+
<input type="hidden" name="check_keywords" value="yes" />
80+
<input type="hidden" name="area" value="default" />
81+
</form>
82+
</div>
83+
84+
85+
</div>
86+
87+
88+
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
89+
90+
91+
92+
93+
94+
95+
<ul>
96+
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
97+
</ul>
98+
<p class="caption"><span class="caption-text">API Documentation</span></p>
99+
<ul>
100+
<li class="toctree-l1"><a class="reference internal" href="../index_b.html">Basics (libfmp.b)</a></li>
101+
<li class="toctree-l1"><a class="reference internal" href="../index_c1.html">Music Representations (libfmp.c1)</a></li>
102+
<li class="toctree-l1"><a class="reference internal" href="../index_c2.html">Fourier Analysis of Signals (libfmp.c2)</a></li>
103+
<li class="toctree-l1"><a class="reference internal" href="../index_c3.html">Music Synchronization (libfmp.c3)</a></li>
104+
<li class="toctree-l1"><a class="reference internal" href="../index_c4.html">Music Structure Analysis (libfmp.c4)</a></li>
105+
<li class="toctree-l1"><a class="reference internal" href="../index_c5.html">Chord Recognition (libfmp.c5)</a></li>
106+
<li class="toctree-l1"><a class="reference internal" href="../index_c6.html">Tempo and Beat Tracking (libfmp.c6)</a></li>
107+
<li class="toctree-l1"><a class="reference internal" href="../index_c7.html">Content-Based Audio Retrieval (libfmp.c7)</a></li>
108+
<li class="toctree-l1"><a class="reference internal" href="../index_c8.html">Musically Informed Audio Decomposition (libfmp.c8)</a></li>
109+
</ul>
110+
<p class="caption"><span class="caption-text">Reference</span></p>
111+
<ul>
112+
<li class="toctree-l1"><a class="reference internal" href="../genindex.html">Index</a></li>
113+
<li class="toctree-l1"><a class="reference internal" href="../py-modindex.html">Module Index</a></li>
114+
</ul>
115+
116+
117+
118+
</div>
119+
120+
</div>
121+
</nav>
122+
123+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
124+
125+
126+
<nav class="wy-nav-top" aria-label="top navigation">
127+
128+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
129+
<a href="../index.html">libfmp</a>
130+
131+
</nav>
132+
133+
134+
<div class="wy-nav-content">
135+
136+
<div class="rst-content">
137+
138+
139+
140+
141+
142+
143+
144+
145+
146+
147+
148+
149+
150+
151+
152+
153+
154+
155+
156+
<div role="navigation" aria-label="breadcrumbs navigation">
157+
158+
<ul class="wy-breadcrumbs">
159+
160+
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
161+
162+
<li>Overview: module code</li>
163+
164+
165+
<li class="wy-breadcrumbs-aside">
166+
167+
</li>
168+
169+
</ul>
170+
171+
172+
<hr/>
173+
</div>
174+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
175+
<div itemprop="articleBody">
176+
177+
<h1>All modules for which code is available</h1>
178+
<ul><li><a href="libfmp/b/b_annotation.html">libfmp.b.b_annotation</a></li>
179+
<li><a href="libfmp/b/b_audio.html">libfmp.b.b_audio</a></li>
180+
<li><a href="libfmp/b/b_layout.html">libfmp.b.b_layout</a></li>
181+
<li><a href="libfmp/b/b_plot.html">libfmp.b.b_plot</a></li>
182+
<li><a href="libfmp/b/b_sonification.html">libfmp.b.b_sonification</a></li>
183+
<li><a href="libfmp/b/b_test_module.html">libfmp.b.b_test_module</a></li>
184+
<li><a href="libfmp/c1/c1s1_sheet_music.html">libfmp.c1.c1s1_sheet_music</a></li>
185+
<li><a href="libfmp/c1/c1s2_symbolic_rep.html">libfmp.c1.c1s2_symbolic_rep</a></li>
186+
<li><a href="libfmp/c1/c1s3_audio_rep.html">libfmp.c1.c1s3_audio_rep</a></li>
187+
<li><a href="libfmp/c2/c2_complex.html">libfmp.c2.c2_complex</a></li>
188+
<li><a href="libfmp/c2/c2_digitization.html">libfmp.c2.c2_digitization</a></li>
189+
<li><a href="libfmp/c2/c2_fourier.html">libfmp.c2.c2_fourier</a></li>
190+
<li><a href="libfmp/c2/c2_interference.html">libfmp.c2.c2_interference</a></li>
191+
<li><a href="libfmp/c2/c2_interpolation.html">libfmp.c2.c2_interpolation</a></li>
192+
<li><a href="libfmp/c3/c3s1_audio_feature.html">libfmp.c3.c3s1_audio_feature</a></li>
193+
<li><a href="libfmp/c3/c3s1_post_processing.html">libfmp.c3.c3s1_post_processing</a></li>
194+
<li><a href="libfmp/c3/c3s1_transposition_tuning.html">libfmp.c3.c3s1_transposition_tuning</a></li>
195+
<li><a href="libfmp/c3/c3s2_dtw.html">libfmp.c3.c3s2_dtw</a></li>
196+
<li><a href="libfmp/c3/c3s2_dtw_plot.html">libfmp.c3.c3s2_dtw_plot</a></li>
197+
<li><a href="libfmp/c3/c3s3_tempo_curve.html">libfmp.c3.c3s3_tempo_curve</a></li>
198+
<li><a href="libfmp/c4/c4s1_annotation.html">libfmp.c4.c4s1_annotation</a></li>
199+
<li><a href="libfmp/c4/c4s2_ssm.html">libfmp.c4.c4s2_ssm</a></li>
200+
<li><a href="libfmp/c4/c4s2_synthetic_ssm.html">libfmp.c4.c4s2_synthetic_ssm</a></li>
201+
<li><a href="libfmp/c4/c4s2_threshold.html">libfmp.c4.c4s2_threshold</a></li>
202+
<li><a href="libfmp/c4/c4s3_thumbnail.html">libfmp.c4.c4s3_thumbnail</a></li>
203+
<li><a href="libfmp/c4/c4s4_novelty_kernel.html">libfmp.c4.c4s4_novelty_kernel</a></li>
204+
<li><a href="libfmp/c4/c4s4_structure_feature.html">libfmp.c4.c4s4_structure_feature</a></li>
205+
<li><a href="libfmp/c4/c4s5_evaluation.html">libfmp.c4.c4s5_evaluation</a></li>
206+
<li><a href="libfmp/c5/c5s1_basic_theory_harmony.html">libfmp.c5.c5s1_basic_theory_harmony</a></li>
207+
<li><a href="libfmp/c5/c5s2_chord_rec_template.html">libfmp.c5.c5s2_chord_rec_template</a></li>
208+
<li><a href="libfmp/c5/c5s3_chord_rec_hmm.html">libfmp.c5.c5s3_chord_rec_hmm</a></li>
209+
<li><a href="libfmp/c6/c6s1_onset_detection.html">libfmp.c6.c6s1_onset_detection</a></li>
210+
<li><a href="libfmp/c6/c6s1_peak_picking.html">libfmp.c6.c6s1_peak_picking</a></li>
211+
<li><a href="libfmp/c6/c6s2_tempo_analysis.html">libfmp.c6.c6s2_tempo_analysis</a></li>
212+
<li><a href="libfmp/c6/c6s3_adaptive_windowing.html">libfmp.c6.c6s3_adaptive_windowing</a></li>
213+
<li><a href="libfmp/c6/c6s3_beat_tracking.html">libfmp.c6.c6s3_beat_tracking</a></li>
214+
<li><a href="libfmp/c7/c7s1_audio_id.html">libfmp.c7.c7s1_audio_id</a></li>
215+
<li><a href="libfmp/c7/c7s2_audio_matching.html">libfmp.c7.c7s2_audio_matching</a></li>
216+
<li><a href="libfmp/c7/c7s3_version_id.html">libfmp.c7.c7s3_version_id</a></li>
217+
<li><a href="libfmp/c8/c8s1_hps.html">libfmp.c8.c8s1_hps</a></li>
218+
<li><a href="libfmp/c8/c8s2_f0.html">libfmp.c8.c8s2_f0</a></li>
219+
<li><a href="libfmp/c8/c8s2_salience.html">libfmp.c8.c8s2_salience</a></li>
220+
<li><a href="libfmp/c8/c8s3_nmf.html">libfmp.c8.c8s3_nmf</a></li>
221+
</ul>
222+
223+
</div>
224+
225+
</div>
226+
<footer>
227+
228+
<hr/>
229+
230+
<div role="contentinfo">
231+
<p>
232+
&#169; Copyright 2021, Meinard Müller and Frank Zalkow.
233+
234+
</p>
235+
</div>
236+
237+
238+
239+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
240+
241+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
242+
243+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
244+
245+
</footer>
246+
</div>
247+
</div>
248+
249+
</section>
250+
251+
</div>
252+
253+
254+
<script type="text/javascript">
255+
jQuery(function () {
256+
SphinxRtdTheme.Navigation.enable(true);
257+
});
258+
</script>
259+
260+
261+
262+
263+
264+
265+
</body>
266+
</html>

0 commit comments

Comments
 (0)