Skip to content

docs.rs can't build #44

@roberth

Description

@roberth

docs.rs fails in our build.rs.

Solutions and workarounds:

A: Make our build.rs succeed

If they only need build.rs and not a real compilation, this could work.
-sys crates will be empty.

You can customize docs.rs builds by defining [package.metadata.docs.rs] table in your crates' Cargo.toml.

https://docs.rs/about/metadata

B: Get docs.rs to install Nix in their docs building sandbox

NOT the Nix libraries, but the tool, enabling all Rust packages to retrieve their deps through Nix, giving them a lot more flexibility.
Prior art for this: replit, firebase

C: Ubuntu package

Easy, but lags behind. Docs.rs requires Ubuntu 24.04 as of writing.
nix-bin was added in 25.10, at Nix version 2.26, which has C API, but lacks more recent additions

D: Get docs.rs to accept locally built docs

Requires a bit more setup on our end.
They probably shouldn't trust third party HTML/CSS.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No fields configured for Task.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions