-
Notifications
You must be signed in to change notification settings - Fork 13.5k
Add missing suffix for sidebar-items script path #92742
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Add missing suffix for sidebar-items script path #92742
Conversation
r? @notriddle |
@@ -665,7 +665,7 @@ impl<'tcx> FormatRenderer<'tcx> for Context<'tcx> { | |||
_ => unreachable!(), | |||
}; | |||
let items = self.build_sidebar_items(module); | |||
let js_dst = self.dst.join("sidebar-items.js"); | |||
let js_dst = self.dst.join(&format!("sidebar-items{}.js", self.shared.resource_suffix)); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GuillaumeGomez just a thought:
docs.rs is using static file categorization like this:
let mut rustdoc_flags = vec![if create_essential_files {
"--emit=unversioned-shared-resources,toolchain-shared-resources"
} else {
"--emit=invocation-specific"
}
Was sidebar-items.js
only missing the resource suffix? Or was/it it also in the wrong category? (correct would be invocation-specific
as I understand it)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sidebar-items isn't a shared resource, or even invocation-specific. It's actually per-module. These URLs all exist, and all have different contents:
- https://doc.rust-lang.org/stable/alloc/sync/sidebar-items.js
- https://doc.rust-lang.org/stable/alloc/sidebar-items.js
- https://doc.rust-lang.org/stable/core/sidebar-items.js
In contrast, search-index is here:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just like @notriddle said. ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks for the explanation!
So as I understand it these are invocation-specific, and when they are different they will be in different paths inside the docs.
Thanks for the quick review @notriddle! @bors: r+ rollup |
📌 Commit 881b427 has been approved by |
Force of habit... @bors: r=notriddle |
💡 This pull request was already approved, no need to approve it again.
|
📌 Commit 881b427 has been approved by |
…ar-items, r=notriddle Add missing suffix for sidebar-items script path Fixes rust-lang/docs.rs#1590. r? `@syphar`
…ar-items, r=notriddle Add missing suffix for sidebar-items script path Fixes rust-lang/docs.rs#1590. r? ``@syphar``
…askrgr Rollup of 14 pull requests Successful merges: - rust-lang#92328 (Tweak sentence in `transmute` docs) - rust-lang#92432 (Error when selected impl is not const in constck) - rust-lang#92506 (Document Box<T> FFI guarantee in 1.41.0 release notes) - rust-lang#92699 (rustdoc: Display "private fields" instead of "fields omitted") - rust-lang#92703 (RELEASES.md: Add 1.58 release note for `File::options` stabilization) - rust-lang#92707 (Extended the note on the use of `no_run` attribute) - rust-lang#92709 (Improve documentation for File::options to give a more likely example) - rust-lang#92720 (Fix doc formatting for time.rs) - rust-lang#92732 (Add note about upstream commit musl-patch-configure.diff is derived from) - rust-lang#92742 (Add missing suffix for sidebar-items script path) - rust-lang#92748 (Eliminate "boxed" wording in `std::error::Error` documentation) - rust-lang#92754 (Update AsmArgs field visibility for rustfmt) - rust-lang#92756 (:arrow_up: rust-analyzer) - rust-lang#92764 (Fix rust logo style) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Fixes rust-lang/docs.rs#1590.
r? @syphar