当本地库不存在时，如何构建FFI crate的docs.rs文档？

Question

我有一个“sys”包，它静态链接到一个库：

Cargo.toml:

[package]
links = "foo-1.0"

build.rs:

fn main() {
    println!("cargo:rustc-link-lib=dylib=foo-1.0");
}

当我发布包时，docs.rs 无法生成文档，因为未安装 libfoo：

error: failed to run custom build command for `foo-sys v0.0.1`

Caused by:
  process didn't exit successfully: `/home/cratesfyi/cratesfyi/debug/build/foo-sys-f4bd3ee95677500b/build-script-build` (exit code: 1)
--- stderr
`"pkg-config" "--libs" "--cflags" "foo-1.0 >= 1.0"` did not exit successfully: exit code: 1
--- stderr

如何配置我的Crate，使得在未安装库的情况下生成文档？

- Boiethios

Answer 1

有关 docs.rs 的 about/build 页面 提供了更多信息。docs.rs 将设置一个环境变量 DOCS_RS。

在 build.rs 中可以禁用链接：

fn main() {
    if std::env::var("DOCS_RS").is_ok() {
        println!("cargo:rustc-link-lib=dylib=foo-1.0");
    }
}

- Boiethios