Skip to content

Commit

Permalink
Fix rendering of links in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
psobot committed May 14, 2024
1 parent bbe15d3 commit 9ab77d3
Show file tree
Hide file tree
Showing 10 changed files with 31 additions and 28 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- Support for reading and writing AIFF, FLAC, MP3, OGG, and WAV files on all platforms with no dependencies
- Additional support for reading AAC, AC3, WMA, and other formats depending on platform
- Support for on-the-fly resampling of audio files and streams with `O(1)` memory usage
- Live audio effects via <a href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream"><code><span class="pre">AudioStream</span></code></a>
- Live audio effects via <a href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream"><code class="docutils literal"><span class="pre">AudioStream</span></code></a>
- Built-in support for a number of basic audio transformations, including:
- Guitar-style effects: `Chorus`, `Distortion`, `Phaser`, `Clipping`
- Loudness and dynamic range effects: `Compressor`, `Gain`, `Limiter`
Expand All @@ -35,7 +35,7 @@
- Pitch effects: `PitchShift`
- Lossy compression: `GSMFullRateCompressor`, `MP3Compressor`
- Quality reduction: `Resample`, `Bitcrush`
- Supports VST3® instrument and effect plugins on macOS, Windows, and Linux (<a href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.load_plugin"><code><span class="pre">pedalboard.load_plugin</span></code></a>)
- Supports VST3® instrument and effect plugins on macOS, Windows, and Linux (<a href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.load_plugin"><code class="docutils literal"><span class="pre">pedalboard.load_plugin</span></code></a>)
- Supports instrument and effect Audio Units on macOS
- Strong thread-safety, memory usage, and speed guarantees
- Releases Python's Global Interpreter Lock (GIL) to allow use of multiple CPU cores
Expand Down Expand Up @@ -74,7 +74,7 @@ If you are new to Python, follow [INSTALLATION.md](https://github.com/spotify/pe

## Examples

> **Note**: If you'd rather watch a video instead of reading examples or documentation, **watch [_Working with Audio in Python (feat. Pedalboard)_ on YouTube](https://www.youtube.com/watch?v=NYhkqXpFAlg)**.
> **Note**: If you'd rather watch a video instead of reading examples or documentation, <strong>watch <a href="https://www.youtube.com/watch?v=NYhkqXpFAlg" target="_blank"><em>Working with Audio in Python (feat. Pedalboard)</em> on YouTube</a></strong>.
### Quick start

Expand Down Expand Up @@ -104,8 +104,8 @@ with AudioFile('some-file.wav') as f:

> **Note**: For more information about how to process audio through
> Pedalboard plugins, including how the `reset` parameter works,
> see [the documentation for `pedalboard.Plugin.process`](
> https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.Plugin.process).
> see <a href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.Plugin.process">
> the documentation for <code class="docutils literal"><span class="pre">pedalboard.Plugin.process</span></code></a>.
### Making a guitar-style pedalboard

Expand Down Expand Up @@ -226,7 +226,8 @@ board = Pedalboard([
### Running Pedalboard on Live Audio

On macOS or Windows, Pedalboard supports streaming live audio through
[an `AudioStream` object](https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream),
<a href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream">
an <code class="docutils literal"><span class="pre">AudioStream</span></code> object</a>,
allowing for real-time manipulation of audio by adding effects in Python.

```python
Expand Down Expand Up @@ -304,7 +305,7 @@ To cite via BibTeX:
```

## License
`pedalboard` is Copyright 2021-2023 Spotify AB.
`pedalboard` is Copyright 2021-2024 Spotify AB.

`pedalboard` is licensed under the [GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html). `pedalboard` includes a number of libraries that are statically compiled, and which carry the following licenses:

Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/examples.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@ Examples

.. mdinclude:: ../../README.md
:start-line: 75
:end-line: 283
:end-line: 284
4 changes: 2 additions & 2 deletions docs/_sources/license.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@ License
=======

.. mdinclude:: ../../README.md
:start-line: 306
:end-line: 318
:start-line: 307
:end-line: 319
12 changes: 7 additions & 5 deletions docs/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<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.9.5 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:description" content="Note: If you’d rather watch a video instead of reading examples or documentation,. Quick start: Note: For more information about how to process audio through Pedalboard plugins, including how the r..." />
<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..." />
<meta name="description" content="Note: If you’d rather watch a video instead of reading examples or documentation,. Quick start: Note: For more information about how to process audio through Pedalboard plugins, including how the r..." />
<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"/>
Expand Down Expand Up @@ -214,7 +214,7 @@
<section id="examples">
<h1>Examples<a class="headerlink" href="#examples" title="Permalink to this heading">#</a></h1>
<blockquote>
<div><p><strong>Note</strong>: If you’d rather watch a video instead of reading examples or documentation, <a href="#id1"><span class="problematic" id="id2">**</span></a>watch <a class="reference external" href="https://www.youtube.com/watch?v=NYhkqXpFAlg">*Working with Audio in Python (feat. Pedalboard)* on YouTube</a><a href="#id3"><span class="problematic" id="id4">**</span></a>.</p>
<div><p><strong>Note</strong>: If you’d rather watch a video instead of reading examples or documentation, <span class="raw-html-m2r"><strong>watch <a href="https://www.youtube.com/watch?v=NYhkqXpFAlg" target="_blank"><em>Working with Audio in Python (feat. Pedalboard)</em> on YouTube</a></strong></span>.</p>
</div></blockquote>
<section id="quick-start">
<h2>Quick start<a class="headerlink" href="#quick-start" title="Permalink to this heading">#</a></h2>
Expand Down Expand Up @@ -244,7 +244,8 @@ <h2>Quick start<a class="headerlink" href="#quick-start" title="Permalink to thi
<blockquote>
<div><p><strong>Note</strong>: For more information about how to process audio through
Pedalboard plugins, including how the <code class="docutils literal notranslate"><span class="pre">reset</span></code> parameter works,
see <cite>the documentation for ``pedalboard.Plugin.process`</cite> &lt;<a class="reference external" href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.Plugin.process">https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.Plugin.process</a>&gt;`_.</p>
see <span class="raw-html-m2r"><a href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.Plugin.process">
the documentation for <code class="docutils literal"><span class="pre">pedalboard.Plugin.process</span></code></a></span>.</p>
</div></blockquote>
</section>
<section id="making-a-guitar-style-pedalboard">
Expand Down Expand Up @@ -365,7 +366,8 @@ <h2>Creating parallel effects chains<a class="headerlink" href="#creating-parall
<section id="running-pedalboard-on-live-audio">
<h2>Running Pedalboard on Live Audio<a class="headerlink" href="#running-pedalboard-on-live-audio" title="Permalink to this heading">#</a></h2>
<p>On macOS or Windows, Pedalboard supports streaming live audio through
<cite>an ``AudioStream`</cite> object &lt;<a class="reference external" href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream">https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream</a>&gt;`_,
<span class="raw-html-m2r"><a href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream">
an <code class="docutils literal"><span class="pre">AudioStream</span></code> object</a></span>,
allowing for real-time manipulation of audio by adding effects in Python.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">pedalboard</span> <span class="kn">import</span> <span class="n">Pedalboard</span><span class="p">,</span> <span class="n">Chorus</span><span class="p">,</span> <span class="n">Compressor</span><span class="p">,</span> <span class="n">Delay</span><span class="p">,</span> <span class="n">Gain</span><span class="p">,</span> <span class="n">Reverb</span><span class="p">,</span> <span class="n">Phaser</span>
<span class="kn">from</span> <span class="nn">pedalboard.io</span> <span class="kn">import</span> <span class="n">AudioStream</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ <h1>Features<a class="headerlink" href="#features" title="Permalink to this head
<li><p>Support for reading and writing AIFF, FLAC, MP3, OGG, and WAV files on all platforms with no dependencies</p></li>
<li><p>Additional support for reading AAC, AC3, WMA, and other formats depending on platform</p></li>
<li><p>Support for on-the-fly resampling of audio files and streams with <code class="docutils literal notranslate"><span class="pre">O(1)</span></code> memory usage</p></li>
<li><p>Live audio effects via <cite>``AudioStream`</cite> &lt;<a class="reference external" href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream">https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream</a>&gt;`_</p></li>
<li><p>Live audio effects via <span class="raw-html-m2r"><a href="https://spotify.github.io/pedalboard/reference/pedalboard.io.html#pedalboard.io.AudioStream"><code class="docutils literal"><span class="pre">AudioStream</span></code></a></span></p></li>
</ul>
</li>
<li><p>Built-in support for a number of basic audio transformations, including:</p>
Expand All @@ -248,7 +248,7 @@ <h1>Features<a class="headerlink" href="#features" title="Permalink to this head
<li><p>Quality reduction: <code class="docutils literal notranslate"><span class="pre">Resample</span></code>, <code class="docutils literal notranslate"><span class="pre">Bitcrush</span></code></p></li>
</ul>
</li>
<li><p>Supports VST3® instrument and effect plugins on macOS, Windows, and Linux (<cite>``pedalboard.load_plugin`</cite> &lt;<a class="reference external" href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.load_plugin">https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.load_plugin</a>&gt;`_)</p></li>
<li><p>Supports VST3® instrument and effect plugins on macOS, Windows, and Linux (<span class="raw-html-m2r"><a href="https://spotify.github.io/pedalboard/reference/pedalboard.html#pedalboard.load_plugin"><code class="docutils literal"><span class="pre">pedalboard.load_plugin</span></code></a></span>)</p></li>
<li><p>Supports instrument and effect Audio Units on macOS</p></li>
<li><p>Strong thread-safety, memory usage, and speed guarantees</p>
<ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/license.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
<meta property="og:type" content="website" />
<meta property="og:url" content="https://spotify.github.io/pedalboard/license.html" />
<meta property="og:site_name" content="Pedalboard v0.9.5 Documentation" />
<meta property="og:description" content="pedalboard is Copyright 2021-2023 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..." />
<meta property="og:description" content="pedalboard is Copyright 2021-2024 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..." />
<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 Copyright 2021-2023 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..." />
<meta name="description" content="pedalboard is Copyright 2021-2024 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..." />
<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-5.3.0, furo 2022.09.29"/>
Expand Down Expand Up @@ -213,7 +213,7 @@
<article role="main">
<section id="license">
<h1>License<a class="headerlink" href="#license" title="Permalink to this heading">#</a></h1>
<p><code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> is Copyright 2021-2023 Spotify AB.</p>
<p><code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> is Copyright 2021-2024 Spotify AB.</p>
<p><code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> is licensed under the <a class="reference external" href="https://www.gnu.org/licenses/gpl-3.0.en.html">GNU General Public License v3</a>. <code class="docutils literal notranslate"><span class="pre">pedalboard</span></code> includes a number of libraries that are statically compiled, and which carry the following licenses:</p>
<ul class="simple">
<li><p>The core audio processing code is pulled from <a class="reference external" href="https://juce.com/">JUCE 6</a>, which is <a class="reference external" href="https://juce.com/juce-6-licence">dual-licensed under a commercial license and the GPLv3</a>.</p></li>
Expand Down
Loading

0 comments on commit 9ab77d3

Please sign in to comment.