Skip to content

Run rustdoc as part of CI process / resolve failure on docs.rs #241

@iliekturtles

Description

@iliekturtles

https://docs.rs/crate/uom/0.31.0/builds/332917

v0.31.0 failed to build documentation on docs.rs. Likely cause is time/memory limits based on the SIGKILL in the log. The log also highlights a warning that wasn't caught as part of the CI process.

Running rustdoc as part of CI is complicated because cargo doc doesn't provide a way to pass the -D warnings flag to rustdoc itself. rustdoc doesn't use RUSTFLAGS or a similar variable as far as I can tell and the cargo interface provides no escape to send parameters directly rust doc, e.g. cargo doc -- -D warnings.

Currently uom instructs docs.rs to compile with all features.

uom/Cargo.toml

Lines 19 to 20 in 8a4883b

[package.metadata.docs.rs]
all-features = true

How much time/memory is this taking? Reduce the number of features? Ask for a sandbox limit increase?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions