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

Libstd should set doc root to point to stable docs for stable releases #30693

Closed
bluss opened this issue Jan 4, 2016 · 4 comments · Fixed by #84942
Closed

Libstd should set doc root to point to stable docs for stable releases #30693

bluss opened this issue Jan 4, 2016 · 4 comments · Fixed by #84942
Labels
C-feature-accepted Category: A feature request that has been accepted pending implementation. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@bluss
Copy link
Member

bluss commented Jan 4, 2016

Libstd defines html_root_url = "https://doc.rust-lang.org/nightly/", in its crate root. This should change to point to stable docs for stable releases of rust, so that stable rust/rustdoc generate pages that link to those docs.

@arcnmx
Copy link
Contributor

arcnmx commented Jan 4, 2016

Nitpick that probably doesn't matter: https://doc.rust-lang.org/stable/ vs https://doc.rust-lang.org/1.5.0/ is somewhat of a concern. While using stable is the better option, "stable" doesn't necessarily imply that it will be semver-compatible forever if a Rust 2.0 is ever released!

@brson
Copy link
Contributor

brson commented Aug 12, 2016

A potential solution: #19603

@steveklabnik steveklabnik added T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. and removed A-libs labels Mar 24, 2017
@Mark-Simulacrum Mark-Simulacrum added the C-feature-request Category: A feature request, i.e: not implemented / a PR. label Jul 24, 2017
@dtolnay dtolnay added C-feature-accepted Category: A feature request that has been accepted pending implementation. and removed C-feature-request Category: A feature request, i.e: not implemented / a PR. labels Nov 17, 2017
@dtolnay
Copy link
Member

dtolnay commented Nov 17, 2017

As noted in #35307 (comment), this needs to be automated in a way that does not require a PR like #35307 before every release. I would welcome a PR to solve this permanently if anyone has ideas for how. I don't believe we need an RFC.

@kennytm
Copy link
Member

kennytm commented Nov 17, 2017

Does something like #![html_root_url = concat!("https://doc.rust-lang.org/", env!("RUST_CHANNEL"))] work? IIRC it doesn't (otherwise we would have #[doc = include_str!(...)] already)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature-accepted Category: A feature request that has been accepted pending implementation. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants