[rustdoc] Add new --book-location option to add a link to associated guide and generate it if local#139769
Open
GuillaumeGomez wants to merge 6 commits intorust-lang:mainfrom
Open
[rustdoc] Add new --book-location option to add a link to associated guide and generate it if local#139769GuillaumeGomez wants to merge 6 commits intorust-lang:mainfrom
--book-location option to add a link to associated guide and generate it if local#139769GuillaumeGomez wants to merge 6 commits intorust-lang:mainfrom
Conversation
Loading
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
10 participants
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.
This option adds the possibility to provide a path or a URL to the associated guide of this crate in the crate-level doc page. If the provided argument is a path, then the guide is generated using the
mdbookcrate.It looks like this:
You can give it a try here.
It'll need an FCP before getting merged.
Also I need to add tests when the argument is a path but I'll wait for the feature form to be final before doing it to prevent doing it more than once. 😄
cc @notriddle
r? @camelid