Add --generate-link-to-definition option when building on docs.rs
#1327
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
dhardy
approved these changes
Jul 15, 2023
Cargo.toml
Outdated
| @@ -21,7 +21,7 @@ include = ["src/", "LICENSE-*", "README.md", "CHANGELOG.md", "COPYRIGHT"] | |||
| # To build locally: | |||
| # RUSTDOCFLAGS="--cfg doc_cfg" cargo +nightly doc --all-features --no-deps --open | |||
|
Would you mind fixing the doc tests (see CI failure) at the same time? Thanks |
GuillaumeGomez
force-pushed
the
generate-links-to-def
branch
from
54142af to
0a15e81
Compare
dhardy
approved these changes
Jul 15, 2023
|
@dhardy Can this be merged? I only see some broken links. |
|
Sure. Sorry, got distracted. |
elichai
pushed a commit
to elichai/rand
that referenced
this pull request
Aug 13, 2023
…ust-random#1327) * Add `--generate-link-to-definition` option when building on docs.rs * Fix documentation issues
|
Are we certain this is working? I had to enable |
|
On docs.rs, |
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.
This option generates links in source code pages, allowing to jump to definition and to jump back to doc. It makes browsing the source code pages much nicer. You can see it in action here.