Skip to content

Commit

Permalink
Fix docs.rs build.
Browse files Browse the repository at this point in the history
- Revert 6730edb, since we no longer require
  network access.
- Add missing URL reference.
  • Loading branch information
kinetiknz committed Feb 11, 2025
1 parent feea2d6 commit 8ad71dd
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 252 deletions.
4 changes: 3 additions & 1 deletion cubeb-api/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@
//! is used to interact with system audio. The library itself is a
//! work in progress and is likely lacking documentation and test.
//!
//! [1]: https://github.com/kinetiknz/cubeb/
//! [1]: https://github.com/mozilla/cubeb/
//!
//! The cubeb-rs library exposes the user API of libcubeb. It doesn't
//! expose the internal interfaces, so isn't suitable for extending
//! libcubeb. See [cubeb-pulse-rs][2] for an example of extending
//! libcubeb via implementing a cubeb backend in rust.
//!
//! [2]: https://github.com/mozilla/cubeb-pulse-rs/
//!
//! To get started, have a look at the [`StreamBuilder`]
// Copyright © 2017-2018 Mozilla Foundation
Expand Down
5 changes: 0 additions & 5 deletions cubeb-sys/build.rs
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ fn main() {
return;
}

if env::var("DOCS_RS").is_ok() {
// Use stubs, not libcubeb, for docs.rs.
return;
}

let _ = fs::remove_dir_all(env::var("OUT_DIR").unwrap());
t!(fs::create_dir_all(env::var("OUT_DIR").unwrap()));

Expand Down
243 changes: 0 additions & 243 deletions cubeb-sys/src/documentation_libcubeb_stubs.rs

This file was deleted.

3 changes: 0 additions & 3 deletions cubeb-sys/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,6 @@ mod mixer;
mod resampler;
mod stream;

#[cfg(docsrs)]
mod documentation_libcubeb_stubs;

pub use audio_dump::*;
pub use callbacks::*;
pub use channel::*;
Expand Down

0 comments on commit 8ad71dd

Please sign in to comment.