Bump to v0.8.3.

spotify · Oct 7, 2023 · 9a92fae · 9a92fae
1 parent a213531
commit 9a92fae
Show file tree

Hide file tree

Showing 21 changed files with 472 additions and 368 deletions.
diff --git a/.github/workflows/all.yml b/.github/workflows/all.yml
@@ -173,36 +173,6 @@ jobs:
           LD_PRELOAD=$(clang -print-file-name=libclang_rt.asan-x86_64.so) \
           pytest -v
 
-  test-docs:
-    runs-on: macos-12
-    continue-on-error: true
-    needs: [run-tests]
-    name: Ensure docs match auto-generated docs
-    if: github.ref == 'refs/heads/master'
-    steps:
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: '3.10'
-      - uses: actions/checkout@v2
-        with:
-          submodules: recursive
-      - name: Install test dependencies
-        env:
-          # on macOS and with Python 3.10: building NumPy from source fails without these options:
-          NPY_BLAS_ORDER: ""
-          NPY_LAPACK_ORDER: ""
-        run: |
-          python -m pip install --upgrade pip
-          pip install wheel
-          pip install -r test-requirements.txt
-      - name: Build pedalboard locally
-        run: python setup.py develop
-      - name: Generate type stubs and documentation, and validate they match
-        # Only validate documentation on macOS, as Linux and Windows have a subset of the classes
-        # TODO: 3.11.0-rc1 doesn't include type hints when generating type stubs.
-        run: python3 -m scripts.generate_type_stubs_and_docs --check
-
   build-wheels:
     needs: [lint-python, lint-cpp]
     runs-on: ${{ matrix.os }}

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.8.2',
+    VERSION: 'v0.8.3',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/compatibility.html b/docs/compatibility.html
@@ -6,15 +6,15 @@
 <meta property="og:title" content="Plugin Compatibility" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://spotify.github.io/pedalboard/compatibility.html" />
-<meta property="og:site_name" content="Pedalboard v0.8.2 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.8.3 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..." />
 <meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
 <meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta name="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..." />
 <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-5.3.0, furo 2022.09.29"/>
-        <title>Plugin Compatibility - Pedalboard v0.8.2 Documentation</title>
+        <title>Plugin Compatibility - Pedalboard v0.8.3 Documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -132,7 +132,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Pedalboard v0.8.2 Documentation</div></a>
+      <a href="index.html"><div class="brand">Pedalboard v0.8.3 Documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -158,7 +158,7 @@
     <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Pedalboard v0.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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
@@ -6,15 +6,15 @@
 <meta property="og:title" content="Examples" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://spotify.github.io/pedalboard/examples.html" />
-<meta property="og:site_name" content="Pedalboard v0.8.2 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.8.3 Documentation" />
 <meta property="og:description" content="Note: If you’d rather watch a video instead of reading examples or documentation,** watch*Working with Audio in Python (feat. Pedalboard)* on YouTube**. Quick start: Note: For more information abou..." />
 <meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
 <meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta name="description" content="Note: If you’d rather watch a video instead of reading examples or documentation,** watch*Working with Audio in Python (feat. Pedalboard)* on YouTube**. Quick start: Note: For more information abou..." />
 <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-5.3.0, furo 2022.09.29"/>
-        <title>Examples - Pedalboard v0.8.2 Documentation</title>
+        <title>Examples - Pedalboard v0.8.3 Documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -132,7 +132,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Pedalboard v0.8.2 Documentation</div></a>
+      <a href="index.html"><div class="brand">Pedalboard v0.8.3 Documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -158,7 +158,7 @@
     <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Pedalboard v0.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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
@@ -6,15 +6,15 @@
 <meta property="og:title" content="Frequently Asked Questions" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://spotify.github.io/pedalboard/faq.html" />
-<meta property="og:site_name" content="Pedalboard v0.8.2 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.8.3 Documentation" />
 <meta property="og:description" content="Can Pedalboard be used with live (real-time) audio?: As of version 0.7.0, yes! See the pedalboard.io.AudioStream class for more details. Does Pedalboard support changing a plugin’s parameters over ..." />
 <meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
 <meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta name="description" content="Can Pedalboard be used with live (real-time) audio?: As of version 0.7.0, yes! See the pedalboard.io.AudioStream class for more details. Does Pedalboard support changing a plugin’s parameters over ..." />
 <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-5.3.0, furo 2022.09.29"/>
-        <title>Frequently Asked Questions - Pedalboard v0.8.2 Documentation</title>
+        <title>Frequently Asked Questions - Pedalboard v0.8.3 Documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -132,7 +132,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Pedalboard v0.8.2 Documentation</div></a>
+      <a href="index.html"><div class="brand">Pedalboard v0.8.3 Documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -158,7 +158,7 @@
     <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Pedalboard v0.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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-5.3.0, furo 2022.09.29"/><title>Index - Pedalboard v0.8.2 Documentation</title>
+    <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/><title>Index - Pedalboard v0.8.3 Documentation</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <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.8.2 Documentation</div></a>
+      <a href="index.html"><div class="brand">Pedalboard v0.8.3 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.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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">
@@ -1018,14 +1018,16 @@ <h2>T</h2>
           <li><a href="reference/pedalboard.html#pedalboard.Resample.target_sample_rate">(pedalboard.Resample property)</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="reference/pedalboard.io.html#pedalboard.io.ReadableAudioFile.tell">tell() (pedalboard.io.ReadableAudioFile method)</a>
 
         <ul>
           <li><a href="reference/pedalboard.io.html#pedalboard.io.ResampledReadableAudioFile.tell">(pedalboard.io.ResampledReadableAudioFile method)</a>
+</li>
+          <li><a href="reference/pedalboard.io.html#pedalboard.io.WriteableAudioFile.tell">(pedalboard.io.WriteableAudioFile method)</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="reference/pedalboard.html#pedalboard.time_stretch">time_stretch() (in module pedalboard)</a>
 </li>
     </ul></td>

diff --git a/docs/index.html b/docs/index.html
@@ -6,15 +6,15 @@
 <meta property="og:title" content="Pedalboard Documentation" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://spotify.github.io/pedalboard/index.html" />
-<meta property="og:site_name" content="Pedalboard v0.8.2 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.8.3 Documentation" />
 <meta property="og:description" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
 <meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta name="description" content="Pedalboard Logo License: GPL v3 Documentation PyPI - Python Version Supported Platforms Apple Silicon support for macOS and Linux (Docker) PyPI - Wheel Test Badge Coverage Badge PyPI - Downloads DO..." />
 <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-5.3.0, furo 2022.09.29"/>
-        <title>Pedalboard v0.8.2 Documentation</title>
+        <title>Pedalboard v0.8.3 Documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -132,7 +132,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="#"><div class="brand">Pedalboard v0.8.2 Documentation</div></a>
+      <a href="#"><div class="brand">Pedalboard v0.8.3 Documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -158,7 +158,7 @@
     <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Pedalboard v0.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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">
@@ -277,7 +277,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 heading">#</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, 3.10, and 3.11 as well as experimental support for 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, 3.11, and 3.12 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
@@ -6,15 +6,15 @@
 <meta property="og:title" content="Pedalboard Internals" />
 <meta property="og:type" content="website" />
 <meta property="og:url" content="https://spotify.github.io/pedalboard/internals.html" />
-<meta property="og:site_name" content="Pedalboard v0.8.2 Documentation" />
+<meta property="og:site_name" content="Pedalboard v0.8.3 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..." />
 <meta property="og:image" content="https://repository-images.githubusercontent.com/383471193/0f79b949-9b91-4436-bfc4-05d30ef384cc" />
 <meta property="og:image:alt" content="🎛 🔊 Documentation for Pedalboard: A Python library for working with audio." />
 <meta name="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..." />
 <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-5.3.0, furo 2022.09.29"/>
-        <title>Pedalboard Internals - Pedalboard v0.8.2 Documentation</title>
+        <title>Pedalboard Internals - Pedalboard v0.8.3 Documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
     <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -132,7 +132,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="index.html"><div class="brand">Pedalboard v0.8.2 Documentation</div></a>
+      <a href="index.html"><div class="brand">Pedalboard v0.8.3 Documentation</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -158,7 +158,7 @@
     <img class="sidebar-logo" src="_static/pedalboard_logo_small.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">Pedalboard v0.8.2 Documentation</span>
+  <span class="sidebar-brand-text">Pedalboard v0.8.3 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">