doc: add CI jobs and hide platform internals

.github/workflows/platforms.yml

@@ -570,7 +570,68 @@ jobs:
       - name: Check WASAPI with windows v${{ matrix.version }}
         run: cargo +${{ env.MSRV_WINDOWS }} check --workspace --verbose
 
-  # cpal publishing (only on cpal release events)
+  docs-cpal:
+    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v')
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - name: Linux
+            target: x86_64-unknown-linux-gnu
+          - name: macOS
+            target: aarch64-apple-darwin
+          - name: Windows
+            target: x86_64-pc-windows-msvc
+          - name: WASM
+            target: wasm32-unknown-unknown
+          - name: Android
+            target: aarch64-linux-android
+    name: docs-${{ matrix.name }}
+    runs-on: ubuntu-latest
+    env:
+      DOCS_RS: "1"
+      RUSTDOCFLAGS: "--cfg docsrs -D warnings"
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Cache Linux audio packages
+        if: matrix.name == 'Linux'
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: ${{ env.PACKAGES_LINUX }}
+
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          targets: ${{ matrix.target }}
+
+      - uses: dtolnay/install@cargo-docs-rs
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: docs-${{ matrix.target }}
+
+      - run: cargo docs-rs --target ${{ matrix.target }}
+
+  docs-asio-sys:
+    if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/asio-sys-v')
+    name: docs (asio-sys)
+    runs-on: ubuntu-latest
+    env:
+      DOCS_RS: "1"
+      RUSTDOCFLAGS: "--cfg docsrs -D warnings"
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: dtolnay/rust-toolchain@nightly
+        with:
+          targets: x86_64-pc-windows-msvc
+
+      - uses: dtolnay/install@cargo-docs-rs
+
+      - run: cargo docs-rs
+        working-directory: asio-sys
+
   publish-cpal:
     if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/v')
     needs:
@@ -586,6 +647,7 @@ jobs:
       - wasm-audioworklet
       - wasm-wasip1
       - windows-versions
+      - docs-cpal
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v5
@@ -614,11 +676,11 @@ jobs:
           CARGO_REGISTRY_TOKEN: ${{ secrets.CRATESIO_TOKEN }}
         run: cargo publish
 
-  # asio-sys publishing (only on asio-sys release events)
   publish-asio-sys:
     if: github.event_name == 'release' && startsWith(github.ref, 'refs/tags/asio-sys-v')
     needs:
       - windows
+      - docs-asio-sys
     runs-on: windows-latest
     env:
       CPAL_ASIO_DIR: ${{ github.workspace }}/asio

.github/workflows/quality.yml

@@ -113,6 +113,33 @@ jobs:
           CPAL_ASIO_DIR: ${{ runner.os == 'Windows' && format('{0}/asio', github.workspace) || '' }}
         run: cargo clippy --all --target ${{ matrix.target }} ${{ matrix.features }} -- -D warnings
 
+  docs:
+    strategy:
+      matrix:
+        include:
+          - name: Linux
+    name: docs-${{ matrix.name }}
+    runs-on: ubuntu-latest
+    env:
+      DOCS_RS: "1"
+      RUSTDOCFLAGS: "--cfg docsrs -D warnings"
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Cache Linux audio packages
+        uses: awalsh128/cache-apt-pkgs-action@latest
+        with:
+          packages: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev libpipewire-0.3-dev
+
+      - uses: dtolnay/rust-toolchain@nightly
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: docs
+
+      - run: cargo doc --all-features --no-deps
+
   lints-nightly:
     strategy:
       fail-fast: false

CHANGELOG.md

@@ -121,6 +121,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Replaced `StreamInstant::add()` and `sub()` by `checked_add()`/`+` and `checked_sub()`/`-`.
 - Removed deprecated `DeviceTrait::name()`.
+- **ALSA**: `AlsaHost` is no longer re-exported from `cpal::platform`.
 - **Emscripten**: Removed broken host; use the WebAudio host instead.
 
 ### Fixed