rustdoc: add unstable option --crate-list-heading to customize the sidebar crate list.
#138143
+116
−25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
r? @notriddle rustbot has assigned @notriddle. Use |
rustbot
added
S-waiting-on-review
|
Some changes occurred in HTML/CSS/JS. cc @GuillaumeGomez, @jsha |
kpreid
changed the title
--crate-list-heading to customize the sidebar crate list.--crate-list-heading to customize the sidebar crate list.
This comment has been minimized.
This comment has been minimized.
kpreid
force-pushed
the
crate-sidebar
branch
2 times, most recently
from
90486a8 to
61edefc
Compare
When used, this option creates a subheading within the sidebar “Crates” list for this crate and all crates which pass the same value. These headings are displayed in alphabetical order; crates without the option, or with it set to the empty string, always appear first. The intended use of this option is to allow Cargo to automatically separate a workspace’s crate list into the workspace’s own crates and their external dependencies. Authors could also use RUSTDOCFLAGS or other means to create custom headings for their documentation builds.
This comment has been minimized.
This comment has been minimized.
notriddle
reviewed
Mar 7, 2025
There was a problem hiding this comment.
Overall, I'm fine with this direction. There are a few nits, but mostly I'm fine with it.
It's nice that Cargo can use this API, so it'll know about things like workspaces, but it's flexible enough that other projects like Linux can use it for their own purposes.
|
Some changes occurred in src/tools/cargo cc @ehuss Some changes occurred in GUI tests. |
|
Ignore that Cargo ping; I accidentally pushed a submodule change (not sure what was going on; I had only uncommitted changes, but it seemed like one of the tests changed the submodule commit too). |
|
The job Click to see the possible cause of the failure (guessed by this bot) |
|
I do not understand the |
|
Do you have an example hosted somewhere by any chance so I can take a look? |
|
☔ The latest upstream changes (presumably #138416) made this pull request unmergeable. Please resolve the merge conflicts. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When used, this option creates a subheading within the sidebar “Crates” list for this crate and all crates which pass the same value. These headings are displayed in alphabetical order; crates without the option, or with it set to the empty string, always appear first.
The intended use of this option is to allow Cargo to automatically separate a workspace’s crate list into the workspace’s own crates and their external dependencies (as requested in #85759 and, loosely, #81031). Even without Cargo support, authors could also use
RUSTDOCFLAGSto create custom headings for their documentation builds (which may address #16328).As currently written, merging this would break all nightly builds against a pre-existing
target/doc/, because the format ofcrates.js(defining variablewindow.ALL_CRATES) is changed. I don’t know whether backwards compatibility is worth implementing here, but it is possible to arrange — I figured I should first get a review of the general idea before polishing it.Example of the new sidebar appearance in one of my workspaces:
Original obsolete version
The vertical margins
<h3>Dependencies</h3>should probably adjusted to have clearer visual hierarchy, but I don’t think that should be done in this PR. Also note that this additional header will not appear until explicitly requested via the flag — in this screenshot I am also using a patched Cargo.@rustbot label A-rustdoc-ui T-rustdoc T-rustdoc-frontend