diff options
| author | steveklabnik <steve@steveklabnik.com> | 2017-08-11 16:24:18 -0400 |
|---|---|---|
| committer | steveklabnik <steve@steveklabnik.com> | 2017-08-11 16:24:18 -0400 |
| commit | 1e4aaea431a7fb87a54fd3dd9600c8a346744ff2 (patch) | |
| tree | e0eb29482481c4835fdc4daad3544c5f5b7f3a8c /src/doc/rustdoc | |
| parent | 92f84424345c72ab5d7b13e931d09d62f8543038 (diff) | |
| download | rust-1e4aaea431a7fb87a54fd3dd9600c8a346744ff2.tar.gz rust-1e4aaea431a7fb87a54fd3dd9600c8a346744ff2.zip | |
address review feedback
Diffstat (limited to 'src/doc/rustdoc')
| -rw-r--r-- | src/doc/rustdoc/src/the-doc-attribute.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/src/doc/rustdoc/src/the-doc-attribute.md b/src/doc/rustdoc/src/the-doc-attribute.md index b77565ec2d7..978d7656bdd 100644 --- a/src/doc/rustdoc/src/the-doc-attribute.md +++ b/src/doc/rustdoc/src/the-doc-attribute.md @@ -46,35 +46,41 @@ These options control how the docs look at a macro level. This form of the `doc` attribute lets you control the favicon of your docs. ```rust,ignore -#![doc(html_favicon_url = "https://foo.com/favicon.ico")] +#![doc(html_favicon_url = "https://example.com/favicon.ico")] ``` This will put `<link rel="shortcut icon" href="{}">` into your docs, where the string for the attribute goes into the `{}`. +If you don't use this attribute, there will be no favicon. + ### `html_logo_url` This form of the `doc` attribute lets you control the logo in the upper left hand side of the docs. ```rust,ignore -#![doc(html_logo_url = "https://foo.com/logo.jpg")] +#![doc(html_logo_url = "https://example.com/logo.jpg")] ``` This will put `<a href='index.html'><img src='{}' alt='logo' width='100'></a>` into your docs, where the string for the attribute goes into the `{}`. +If you don't use this attribute, there will be no logo. + ### `html_playground_url` This form of the `doc` attribute lets you control where the "run" buttons on your documentation examples make requests to. ```rust,ignore -#![doc(html_playground_url = "https://playground.foo.com/")] +#![doc(html_playground_url = "https://playground.example.com/")] ``` Now, when you press "run", the button will make a request to this domain. +If you don't use this attribute, there will be no run buttons. + ### `issue_tracker_base_url` This form of the `doc` attribute is mostly only useful for the standard library; @@ -83,7 +89,7 @@ given. `rustdoc` uses this number, plus the base URL given here, to link to the tracking issue. ```rust,ignore -#![doc(issue_tracker_base_url = "https://github.com/foo/foo/issues/")] +#![doc(issue_tracker_base_url = "https://github.com/rust-lang/rust/issues/")] ``` ### `html_no_source` |
