@@ -46,35 +46,41 @@ These options control how the docs look at a macro level.
46
46
This form of the ` doc ` attribute lets you control the favicon of your docs.
47
47
48
48
``` rust,ignore
49
- #![doc(html_favicon_url = "https://foo .com/favicon.ico")]
49
+ #![doc(html_favicon_url = "https://example .com/favicon.ico")]
50
50
```
51
51
52
52
This will put ` <link rel="shortcut icon" href="{}"> ` into your docs, where
53
53
the string for the attribute goes into the ` {} ` .
54
54
55
+ If you don't use this attribute, there will be no favicon.
56
+
55
57
### ` html_logo_url `
56
58
57
59
This form of the ` doc ` attribute lets you control the logo in the upper
58
60
left hand side of the docs.
59
61
60
62
``` rust,ignore
61
- #![doc(html_logo_url = "https://foo .com/logo.jpg")]
63
+ #![doc(html_logo_url = "https://example .com/logo.jpg")]
62
64
```
63
65
64
66
This will put ` <a href='index.html'><img src='{}' alt='logo' width='100'></a> ` into
65
67
your docs, where the string for the attribute goes into the ` {} ` .
66
68
69
+ If you don't use this attribute, there will be no logo.
70
+
67
71
### ` html_playground_url `
68
72
69
73
This form of the ` doc ` attribute lets you control where the "run" buttons
70
74
on your documentation examples make requests to.
71
75
72
76
``` rust,ignore
73
- #![doc(html_playground_url = "https://playground.foo .com/")]
77
+ #![doc(html_playground_url = "https://playground.example .com/")]
74
78
```
75
79
76
80
Now, when you press "run", the button will make a request to this domain.
77
81
82
+ If you don't use this attribute, there will be no run buttons.
83
+
78
84
### ` issue_tracker_base_url `
79
85
80
86
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
83
89
the tracking issue.
84
90
85
91
``` 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/")]
87
93
```
88
94
89
95
### ` html_no_source `
0 commit comments