Upgrade Sphinx and pin all dependencies.

docs/_static/basic.css

@@ -236,16 +236,6 @@ div.body p, div.body dd, div.body li, div.body blockquote {
 a.headerlink {
  visibility: hidden;
 }
-a.brackets:before,
-span.brackets > a:before{
- content: "[";
-}
-
-a.brackets:after,
-span.brackets > a:after {
- content: "]";
-}
-
 
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
@@ -334,11 +324,15 @@ aside.sidebar {
 p.sidebar-title {
  font-weight: bold;
 }
+nav.contents,
+aside.topic,
 div.admonition, div.topic, blockquote {
  clear: left;
 }
 
 /* -- topics ---------------------------------------------------------------- */
+nav.contents,
+aside.topic,
 div.topic {
  border: 1px solid #ccc;
  padding: 7px;
@@ -377,13 +371,17 @@ div.body p.centered {
 
 div.sidebar > :last-child,
 aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
 div.topic > :last-child,
 div.admonition > :last-child {
  margin-bottom: 0;
 }
 
 div.sidebar::after,
 aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
 div.topic::after,
 div.admonition::after,
 blockquote::after {
@@ -608,19 +606,26 @@ ol.simple p,
 ul.simple p {
  margin-bottom: 0;
 }
-dl.footnote > dt,
-dl.citation > dt {
+aside.footnote > span,
+div.citation > span {
  float: left;
- margin-right: 0.5em;
 }
-
-dl.footnote > dd,
-dl.citation > dd {
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
  margin-bottom: 0em;
 }
-
-dl.footnote > dd:after,
-dl.citation > dd:after {
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
  content: "";
  clear: both;
 }
@@ -636,10 +641,6 @@ dl.field-list > dt {
  padding-left: 0.5em;
  padding-right: 5px;
 }
-dl.field-list > dt:after {
- content: ":";
-}
-
 
 dl.field-list > dd {
  padding-left: 0.5em;

docs/_static/copybutton.css

@@ -35,7 +35,8 @@ div.highlight {
  position: relative;
 }
 
-.highlight:hover button.copybtn {
+/* Show the copybutton */
+.highlight:hover button.copybtn, button.copybtn.success {
  opacity: 1;
 }
 

docs/_static/copybutton.js

@@ -102,18 +102,25 @@ const clearSelection = () => {
  }
 }
 
-// Changes tooltip text for two seconds, then changes it back
+// Changes tooltip text for a moment, then changes it back
+// We want the timeout of our `success` class to be a bit shorter than the
+// tooltip and icon change, so that we can hide the icon before changing back.
+var timeoutIcon = 2000;
+var timeoutSuccessClass = 1500;
+
 const temporarilyChangeTooltip = (el, oldText, newText) => {
  el.setAttribute('data-tooltip', newText)
  el.classList.add('success')
- setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000)
- setTimeout(() => el.classList.remove('success'), 2000)
+ // Remove success a little bit sooner than we change the tooltip
+ // So that we can use CSS to hide the copybutton first
+ setTimeout(() => el.classList.remove('success'), timeoutSuccessClass)
+ setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon)
 }
 
 // Changes the copy button icon for two seconds, then changes it back
 const temporarilyChangeIcon = (el) => {
  el.innerHTML = iconCheck;
- setTimeout(() => {el.innerHTML = iconCopy}, 2000)
+ setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon)
 }
 
 const addCopyButtonToCodeCells = () => {
@@ -125,7 +132,8 @@ const addCopyButtonToCodeCells = () => {
  }
 
  // Add copybuttons to all of our code cells
- const codeCells = document.querySelectorAll('div.highlight pre')
+ const COPYBUTTON_SELECTOR = 'div.highlight pre';
+ const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR)
  codeCells.forEach((codeCell, index) => {
  const id = codeCellId(index)
  codeCell.setAttribute('id', id)
@@ -141,10 +149,25 @@ function escapeRegExp(string) {
  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
 
+/**
+ * Removes excluded text from a Node.
+ *
+ * @param {Node} target Node to filter.
+ * @param {string} exclude CSS selector of nodes to exclude.
+ * @returns {DOMString} Text from `target` with text removed.
+ */
+function filterText(target, exclude) {
+ const clone = target.cloneNode(true); // clone as to not modify the live DOM
+ if (exclude) {
+ // remove excluded nodes
+ clone.querySelectorAll(exclude).forEach(node => node.remove());
+ }
+ return clone.innerText;
+}
+
 // Callback when a copy button is clicked. Will be passed the node that was clicked
 // should then grab the text and replace pieces of text that shouldn't be used in output
 function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
-
  var regexp;
  var match;
 
@@ -199,7 +222,12 @@ function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onl
 
 var copyTargetText = (trigger) => {
  var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
- return formatCopyText(target.innerText, '', false, true, true, true, '', '')
+
+ // get filtered text
+ let exclude = '.linenos, .gp';
+
+ let text = filterText(target, exclude);
+ return formatCopyText(text, '', false, true, true, true, '', '')
 }
 
  // Initialize with a callback so we can modify the text before copy

docs/_static/copybutton_funcs.js

@@ -2,10 +2,25 @@ function escapeRegExp(string) {
  return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
 }
 
+/**
+ * Removes excluded text from a Node.
+ *
+ * @param {Node} target Node to filter.
+ * @param {string} exclude CSS selector of nodes to exclude.
+ * @returns {DOMString} Text from `target` with text removed.
+ */
+export function filterText(target, exclude) {
+ const clone = target.cloneNode(true); // clone as to not modify the live DOM
+ if (exclude) {
+ // remove excluded nodes
+ clone.querySelectorAll(exclude).forEach(node => node.remove());
+ }
+ return clone.innerText;
+}
+
 // Callback when a copy button is clicked. Will be passed the node that was clicked
 // should then grab the text and replace pieces of text that shouldn't be used in output
 export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
-
  var regexp;
  var match;
 

docs/compatibility.html

@@ -2,27 +2,21 @@
 <html class="no-js" lang="en">
  <head><meta charset="utf-8"/>
  <meta name="viewport" content="width=device-width,initial-scale=1"/>
- <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: https://docutils.sourceforge.net/" />
-
+ <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 <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.6.5 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." />
- <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" />
+<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.06.21"/>
+ <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.6.5 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/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
@@ -202,7 +196,8 @@
  <span>Back to top</span>
  </a>
  <div class="content-icon-container">
- <div class="theme-toggle-container theme-toggle-content">
+
+<div class="theme-toggle-container theme-toggle-content">
  <button class="theme-toggle">
  <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
@@ -249,10 +244,10 @@ <h1>Plugin Compatibility<a class="headerlink" href="#plugin-compatibility" title
  </div>
  <div class="title">Pedalboard Internals</div>
  </div>
- <svg><use href="#svg-arrow-right"></use></svg>
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  </a>
  <a class="prev-page" href="faq.html">
- <svg><use href="#svg-arrow-right"></use></svg>
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  <div class="page-info">
  <div class="context">
  <span>Previous</span>

docs/examples.html

@@ -2,27 +2,21 @@
 <html class="no-js" lang="en">
  <head><meta charset="utf-8"/>
  <meta name="viewport" content="width=device-width,initial-scale=1"/>
- <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: https://docutils.sourceforge.net/" />
-
+ <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 <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.6.5 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..." />
-
 <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." />
- <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" />
+<meta name="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..." />
+<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.06.21"/>
+ <link rel="shortcut icon" href="_static/favicon.ico"/><meta name="generator" content="sphinx-5.3.0, furo 2022.09.29"/>
  <title>Examples - Pedalboard v0.6.5 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/styles/furo.css?digest=d81277517bee4d6b0349d71bb2661d4890b5617c" />
  <link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
  <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
 
@@ -202,7 +196,8 @@
  <span>Back to top</span>
  </a>
  <div class="content-icon-container">
- <div class="theme-toggle-container theme-toggle-content">
+
+<div class="theme-toggle-container theme-toggle-content">
  <button class="theme-toggle">
  <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
@@ -368,10 +363,10 @@ <h2>Creating parallel effects chains<a class="headerlink" href="#creating-parall
  </div>
  <div class="title">Frequently Asked Questions</div>
  </div>
- <svg><use href="#svg-arrow-right"></use></svg>
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  </a>
  <a class="prev-page" href="reference/pedalboard.io.html">
- <svg><use href="#svg-arrow-right"></use></svg>
+ <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  <div class="page-info">
  <div class="context">
  <span>Previous</span>
@@ -413,7 +408,7 @@ <h2>Creating parallel effects chains<a class="headerlink" href="#creating-parall
  <div class="toc-sticky toc-scroll">
  <div class="toc-title-container">
  <span class="toc-title">
- Contents
+ On this page
  </span>
  </div>
  <div class="toc-tree-container">