Skip to content
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

rustdoc should add repository links automatically #72475

Open
lzybkr opened this issue May 22, 2020 · 3 comments
Open

rustdoc should add repository links automatically #72475

lzybkr opened this issue May 22, 2020 · 3 comments
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@lzybkr
Copy link
Contributor

lzybkr commented May 22, 2020

It's handy to jump from docs to a repo, e.g. to explore/open issues, find examples, etc.

As an example of what this might look like, see anyhow.
image

Can the repository field be extracted from Cargo.toml easily enough so this wouldn't require any user changes to enable?

@jonas-schievink jonas-schievink added C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels May 22, 2020
@GuillaumeGomez
Copy link
Member

It's not up to rustdoc but to cargo. rustdoc doesn't use the Cargo.toml file.

@lzybkr
Copy link
Contributor Author

lzybkr commented May 25, 2020

Would it make sense for rustdoc to add a command line parameter --repository so cargo can pass the link?

@GuillaumeGomez
Copy link
Member

I guess it'd be acceptable yes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-request Category: A feature request, i.e: not implemented / a PR. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

3 participants