Skip to content

Commit 189db47

Browse files
authored
fix: exclude pipewire from docs.rs (#1239)
docs.rs does not have libspa-sys installed.
1 parent 45fe976 commit 189db47

2 files changed

Lines changed: 15 additions & 2 deletions

File tree

.github/workflows/platforms.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,9 @@ env:
3636

3737
PACKAGES_LINUX: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev libpipewire-0.3-dev
3838

39+
# Mirrors the packages actually present in docs.rs's sandboxed build environment
40+
PACKAGES_DOCS_RS: libasound2-dev libjack-jackd2-0 libdbus-1-dev libpulse-dev
41+
3942
ANDROID_COMPILE_SDK: "30"
4043
ANDROID_BUILD_TOOLS: "30.0.3"
4144

@@ -600,7 +603,7 @@ jobs:
600603
if: matrix.name == 'Linux'
601604
uses: awalsh128/cache-apt-pkgs-action@latest
602605
with:
603-
packages: ${{ env.PACKAGES_LINUX }}
606+
packages: ${{ env.PACKAGES_DOCS_RS }}
604607

605608
- uses: dtolnay/rust-toolchain@nightly
606609
with:

Cargo.toml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,17 @@ name = "record_wav"
217217
name = "synth_tones"
218218

219219
[package.metadata.docs.rs]
220-
all-features = true
220+
# The docs.rs build environment does not have all the dependencies for all features
221+
features = [
222+
"asio",
223+
"audioworklet",
224+
"custom",
225+
"jack",
226+
"pulseaudio",
227+
"realtime",
228+
"realtime-dbus",
229+
"wasm-bindgen",
230+
]
221231
rustdoc-args = ["--cfg", "docsrs"]
222232
targets = [
223233
"x86_64-unknown-linux-gnu",

0 commit comments

Comments
 (0)