@@ -46,35 +46,41 @@ These options control how the docs look at a macro level.
4646This form of the ` doc ` attribute lets you control the favicon of your docs.
4747
4848``` rust,ignore
49- #![doc(html_favicon_url = "https://foo .com/favicon.ico")]
49+ #![doc(html_favicon_url = "https://example .com/favicon.ico")]
5050```
5151
5252This will put ` <link rel="shortcut icon" href="{}"> ` into your docs, where
5353the string for the attribute goes into the ` {} ` .
5454
55+ If you don't use this attribute, there will be no favicon.
56+
5557### ` html_logo_url `
5658
5759This form of the ` doc ` attribute lets you control the logo in the upper
5860left hand side of the docs.
5961
6062``` rust,ignore
61- #![doc(html_logo_url = "https://foo .com/logo.jpg")]
63+ #![doc(html_logo_url = "https://example .com/logo.jpg")]
6264```
6365
6466This will put ` <a href='index.html'><img src='{}' alt='logo' width='100'></a> ` into
6567your docs, where the string for the attribute goes into the ` {} ` .
6668
69+ If you don't use this attribute, there will be no logo.
70+
6771### ` html_playground_url `
6872
6973This form of the ` doc ` attribute lets you control where the "run" buttons
7074on your documentation examples make requests to.
7175
7276``` rust,ignore
73- #![doc(html_playground_url = "https://playground.foo .com/")]
77+ #![doc(html_playground_url = "https://playground.example .com/")]
7478```
7579
7680Now, when you press "run", the button will make a request to this domain.
7781
82+ If you don't use this attribute, there will be no run buttons.
83+
7884### ` issue_tracker_base_url `
7985
8086This 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
8389the tracking issue.
8490
8591``` rust,ignore
86- #![doc(issue_tracker_base_url = "https://github.com/foo/foo /issues/")]
92+ #![doc(issue_tracker_base_url = "https://github.com/rust-lang/rust /issues/")]
8793```
8894
8995### ` html_no_source `
0 commit comments