qdrant / qdrant/rust-client

bug: Rust crates that depend on `qdrant-client` break trying to build docs

Open
#239 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
415
Forks
83
Avg merge
2h 20m
Merged PRs (30d)
3

Description

Logs: https://docs.rs/crate/rig-qdrant/0.1.23/builds/2442024

From docs.rs:

Most of the sandbox is a read-only file system, including the source directory of your crate and its dependencies. If your build.rs generates files that are relevant for documentation, consider writing to the cargo output directory, passed in the environment variable OUT_DIR.

Looks like the qdrant-client build.rs file writes to what would be considered a read-only part of the sandbox (./tests, ...), breaking the docs build.

We can probably fix this by writing the following at the start of the build.rs fn main():

if std::env::var("DOCS_RS").is_ok() {
    return;
}

I am quite keen to get this fixed as Rig (which I maintain) is starting to become quite a heavily used library.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Inspect build.rs and the docs.rs build log linked in the issue, then check how the build behaves when DOCS_RS is set. Reproduce the failure with the documented crate build if possible; done means qdrant-client and dependent crates build their documentation successfully in the docs.rs sandbox.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.