OpenE2K/rust
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Rollup merge of #60278 - ehuss:doc-html_root_url, r=GuillaumeGomez

Browse Source 
Document the `html_root_url` doc attribute value.

I'm not sure if this was intentionally not documented, but I think it would be good to include. This was added in #9691.  `--extern-html-root-url` is unstable, but I don't think it hurts to mention it.
This commit is contained in:
Manish Goregaokar 2019-05-16 12:31:44 -07:00 committed by GitHub
commit 2ae06976e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/doc/rustdoc/src/the-doc-attribute.md
View File

@ -92,6 +92,21 @@ the tracking issue.
#![doc(issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")]
```
### `html_root_url`
The `#[doc(html_root_url = "…")]` attribute value indicates the URL for
generating links to external crates. When rustdoc needs to generate a link to
an item in an external crate, it will first check if the extern crate has been
documented locally on-disk, and if so link directly to it. Failing that, it
will use the URL given by the `--extern-html-root-url` command-line flag if
available. If that is not available, then it will use the `html_root_url`
value in the extern crate if it is available. If that is not available, then
the extern items will not be linked.
```rust,ignore
#![doc(html_root_url = "https://docs.rs/serde/1.0")]
```
### `html_no_source`
By default, `rustdoc` will include the source code of your program, with links