Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document possibility of indexing user provided crates #10

Open
philippeitis opened this issue Nov 1, 2021 · 0 comments
Open

Document possibility of indexing user provided crates #10

philippeitis opened this issue Nov 1, 2021 · 0 comments

Comments

@philippeitis
Copy link

philippeitis commented Nov 1, 2021

It is possible to index user provided crates like so:

export RUSTDOCFLAGS="-Zunstable-options --output-format=json"
cargo +nightly doc

Alternatively, in Rust:

std::process::Command::new("cargo")
    .arg("+nightly")
    .arg("doc")
    .env("RUSTDOCFLAGS", "-Zunstable-options --output-format=json")
    .env("CARGO_TARGET_DIR", &index_dir)
    .current_dir(crate_path)
    .output();

I think it would be useful to document this as an option somewhere in the roogle-engine documentation or README.md, or both. However, it does run into internal compiler errors, so it will not currently work for all projects.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant