-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
rustbuild builds docs for too many crates #38319
Comments
I'd say it's a bit more complex than that: we do want the ability to build these docs, but don't currently include them in the releases. |
I'm going to preemptively tag this as a regression as it'll soon become one. I suspect we can fix this by just disabling rustdoc in Cargo.toml for a bunch of crates. Should be an easy thing to knock out! |
Nightly docs may show effect of this? Search index only contains getopts, term, test crates. See example: https://doc.rust-lang.org/nightly/std/index.html?search=Vec |
They cause the search index from the std docs to get overwritten just like rust-lang#34800. Part of rust-lang#38319.
Yeah, I figured that might happen. I've submitted a small PR to fix that: #38398. |
rustbuild: Stop building docs for libtest by default They cause the search index from the std docs to get overwritten just like rust-lang#34800. Part of rust-lang#38319.
Retain the same behavior as stable. Closes rust-lang#38319
std: Don't build docs for misc facade crates Retain the same behavior as stable. Closes #38319
Retain the same behavior as stable. Closes rust-lang#38319
They cause the search index from the std docs to get overwritten just like rust-lang#34800. Part of rust-lang#38319.
This needs to be reopened. Unfortunately #38658 didn't work, it only disabled docs for |
Still a stable → beta regression in the sense that the currently hosted beta rustdoc shows documentation for too many crates like for example |
Yes sorry @ollie27 I've been meaning to get around to reopening this. I suspect that there's a Cargo bug lurking here as to why we're building too much crate documentation. @ollie27 do you want to send a PR to just explicitly pass |
rustbuild: Stop building docs for std dependancies Fixes: #38319 r? @alexcrichton
The Makefiles only build the docs for:
I assume
alloc
,collections
andrustc_unicode
are included mostly so the src links instd
work. I'm not sure whylibc
is included though...Anyway, with rustbuild it builds all of these:
Most of these are implementation details of
std
so shouldn't be included. Thetest
docs are a big problem because of the same issue as #34800, generating them means the search index will get overridden.The text was updated successfully, but these errors were encountered: