Steps for checking that your html_root_url is correct

[dtolnay]

Hyper has been using a bad html_root_url since 0.10.7 (hyperium/hyper#1193). Let's explain or link to an explanation of how to pick the right html_root_url so users are not forced to guess.

[seanmonstar]

I would much rather this somehow be automated in Cargo or something, maybe via env!("CARGO_PKG_VERSION") or something.

[dtolnay]

Yes keeping the version updated automatically would be great! That would solve the problem of an outdated version in html_root_url like tokio-rs/mio#613.

I don't think it would solve hyperium/hyper@aee7c99 and similar. Rustdoc urls have a tendency to be confusing. Which of these is the right html_root_url?

• https://hyperium.github.io/hyper/hyper/index.html
• https://hyperium.github.io/hyper/hyper/
• https://hyperium.github.io/hyper/hyper
• https://hyperium.github.io/hyper/
• https://hyperium.github.io/hyper
• https://hyperium.github.io/
• https://hyperium.github.io

Let's check the book.

You can control a few aspects of the HTML that rustdoc generates through the #![doc] version of the attribute:

#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
       html_favicon_url = "https://www.rust-lang.org/favicon.ico",
       html_root_url = "https://doc.rust-lang.org/")]

This sets a few different options, with a logo, favicon, and a root URL.

😿

[dtolnay]

The html_root_url attribute is not (yet?) mentioned in the second edition of the book so for now we will need to provide more explanation here than we may like. rust-lang/book#725

[dtolnay]

We removed the html_root_url recommendation.