docs.rs icon indicating copy to clipboard operation
docs.rs copied to clipboard

docs.rs build failed due to tensorflow-sys

Open harloc-AI opened this issue 11 months ago • 1 comments

Crate name

rustai_abalone

Build failure link

https://docs.rs/crate/rustai_abalone/0.1.1/builds/1614420

Additional details

Hello everyone,

Locally generating the docs worked and also my github workflow runs all tests successfully.

I think at the core of this problem is the following:

[INFO] [stderr] warning: target filter specified, but no targets matched; this is a no-op
[INFO] [stderr]    Compiling tensorflow-sys v0.24.0
[INFO] [stderr] error: failed to run custom build command for `tensorflow-sys v0.24.0`

The build environment has some troubles to build tensorflow-sys.

Is there a chance, that I can make some specification that can help? Is there any other way to run the build for docs.rs? What will be the next steps?

Thank you for every help!

All my best,

Harald Locke

harloc-AI avatar Jan 09 '25 16:01 harloc-AI

for these kind of build configurations we have two documentation pages:

  • https://docs.rs/about/builds
  • https://docs.rs/about/metadata

Also it's always helpful to look at how the tensorflow-sys crate itself is configuring its build: https://github.com/tensorflow/rust/blob/454da033e4eb5ac3fff96c7bed9734c49d7e3bd3/tensorflow-sys/Cargo.toml#L18-L19

In this case you see there is a special private/docs-rs feature.

My guess is they are using one of the techniques for building with system dependencies:

having a private feature that makes your crate build without the system dependencies, since most of the time the API/interface you're documenting doesn't actually change depending on the system dependency.

syphar avatar Jan 10 '25 04:01 syphar

I assume my answer did suffice, feel free to reopen / comment if you need more help

syphar avatar Mar 27 '25 08:03 syphar