diff options
| author | Eric Huss <eric@huss.org> | 2019-04-25 11:40:01 -0700 |
|---|---|---|
| committer | Eric Huss <eric@huss.org> | 2019-04-25 11:44:40 -0700 |
| commit | 2e3d5c866fdead26f9e0e2b5620b236fea95c0e7 (patch) | |
| tree | b1e1b057ebcdc1e6653e90ab5ab03659a9c902ea /src/doc | |
| parent | bd31c392f286d61caac0babee68c900cdaa8b504 (diff) | |
Document the `html_root_url` doc attribute value.
Diffstat (limited to 'src/doc')
| -rw-r--r-- | src/doc/rustdoc/src/the-doc-attribute.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index 61e5b3d0133..b165c5a6b3b 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -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 |