Update documentation.

rhelsing · Nov 18, 2022 · e1a6ddd · e1a6ddd
1 parent 6c7f7af
commit e1a6ddd
Show file tree

Hide file tree

Showing 14 changed files with 64 additions and 54 deletions.
diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,6 +1,6 @@
 var DOCUMENTATION_OPTIONS = {
  URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: 'v0.6.3',
+ VERSION: 'v0.6.4',
  LANGUAGE: 'None',
  COLLAPSE_INDEX: false,
  BUILDER: 'html',

diff --git a/docs/compatibility.html b/docs/compatibility.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/compatibility.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="pedalboard allows loading VST3® and Audio Unit plugins, which could contain any code. Most plugins that have been tested work just fine with pedalboard, but some plugins may not work with pedalboar..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Pedalboard Internals" href="internals.html" /><link rel="prev" title="Frequently Asked Questions" href="faq.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>Plugin Compatibility - Pedalboard v0.6.3 Documentation</title>
+ <title>Plugin Compatibility - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/examples.html b/docs/examples.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/examples.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="Quick start: Making a guitar-style pedalboard: Using VST3® or Audio Unit plugins: Creating parallel effects chains: This example creates a delayed pitch-shift effect by running multiple Pedalboards..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Frequently Asked Questions" href="faq.html" /><link rel="prev" title="The pedalboard.io API" href="reference/pedalboard.io.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>Examples - Pedalboard v0.6.3 Documentation</title>
+ <title>Examples - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/faq.html b/docs/faq.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/faq.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="Can Pedalboard be used with live (real-time) audio?: Technically, yes, Pedalboard could be used with live audio input/output. See: Pull request #98, which contains an experimental live audio interf..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Plugin Compatibility" href="compatibility.html" /><link rel="prev" title="Examples" href="examples.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>Frequently Asked Questions - Pedalboard v0.6.3 Documentation</title>
+ <title>Frequently Asked Questions - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -4,7 +4,7 @@
  <meta name="viewport" content="width=device-width,initial-scale=1"/>
  <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search.html" />
 
- <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/><title>Index - Pedalboard v0.6.3 Documentation</title>
+ <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/><title>Index - Pedalboard v0.6.4 Documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -122,7 +122,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -148,7 +148,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/index.html b/docs/index.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/index.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="The pedalboard API" href="reference/pedalboard.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>Pedalboard v0.6.3 Documentation</title>
+ <title>Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="#"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="#"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
@@ -280,7 +280,7 @@ <h1>Installation<a class="headerlink" href="#installation" title="Permalink to t
 <p>If you are new to Python, follow <a class="reference external" href="https://github.com/spotify/pedalboard/blob/master/INSTALLATION.md">INSTALLATION.md</a> for a robust guide.</p>
 <section id="compatibility">
 <h2>Compatibility<a class="headerlink" href="#compatibility" title="Permalink to this headline">#</a></h2>
-<p><code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> is thoroughly tested with Python 3.6, 3.7, 3.8, 3.9, and 3.10 as well as experimental support for Python 3.11 and PyPy 3.7, 3.8, and 3.9.</p>
+<p><code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> is thoroughly tested with Python 3.6, 3.7, 3.8, 3.9, 3.10, and 3.11 as well as experimental support for PyPy 3.7, 3.8, and 3.9.</p>
 <ul class="simple">
 <li><p>Linux</p>
 <ul>

diff --git a/docs/internals.html b/docs/internals.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/internals.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="Pedalboard is a Python wrapper around JUCE, an open-source cross-platform C++ library for developing audio applications. Most of Pedalboard is written in C++ using pybind11, a library for binding C..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="License" href="license.html" /><link rel="prev" title="Plugin Compatibility" href="compatibility.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>Pedalboard Internals - Pedalboard v0.6.3 Documentation</title>
+ <title>Pedalboard Internals - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/license.html b/docs/license.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/license.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="pedalboard is Copyright 2021-2022 Spotify AB. pedalboard is licensed under the GNU General Public License v3. pedalboard includes a number of libraries that are statically compiled, and which carry..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="prev" title="Pedalboard Internals" href="internals.html" />
 
  <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>License - Pedalboard v0.6.3 Documentation</title>
+ <title>License - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -4,7 +4,7 @@
  <meta name="viewport" content="width=device-width,initial-scale=1"/>
  <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" />
 
- <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/><title>Python Module Index - Pedalboard v0.6.3 Documentation</title>
+ <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/><title>Python Module Index - Pedalboard v0.6.4 Documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -122,7 +122,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -148,7 +148,7 @@
  <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">

diff --git a/docs/reference/pedalboard.html b/docs/reference/pedalboard.html
@@ -10,7 +10,7 @@
 
 <meta property="og:url" content="https://spotify.github.io/pedalboard/reference/pedalboard.html" />
 
-<meta property="og:site_name" content="Pedalboard v0.6.3 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.6.4 Documentation" />
 
 <meta property="og:description" content="This module provides classes and functions for adding effects to audio. Most classes in this module are subclasses of Plugin, each of which allows applying effects to an audio buffer or stream. For..." />
 
@@ -20,7 +20,7 @@
  <link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="The pedalboard.io API" href="pedalboard.io.html" /><link rel="prev" title="Features" href="../index.html" />
 
  <link rel="shortcut icon" href="../_static/favicon.ico"/><meta name="generator" content="sphinx-4.4.0, furo 2022.06.21"/>
- <title>The pedalboard API - Pedalboard v0.6.3 Documentation</title>
+ <title>The pedalboard API - Pedalboard v0.6.4 Documentation</title>
  <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
  <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
  <link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
@@ -138,7 +138,7 @@
  </label>
  </div>
  <div class="header-center">
- <a href="../index.html"><div class="brand">Pedalboard v0.6.3 Documentation</div></a>
+ <a href="../index.html"><div class="brand">Pedalboard v0.6.4 Documentation</div></a>
  </div>
  <div class="header-right">
  <div class="theme-toggle-container theme-toggle-header">
@@ -164,7 +164,7 @@
  <img class="sidebar-logo" src="../_static/pedalboard_logo_small.png" alt="Logo"/>
  </div>
 
- <span class="sidebar-brand-text">Pedalboard v0.6.3 Documentation</span>
+ <span class="sidebar-brand-text">Pedalboard v0.6.4 Documentation</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
  <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">