Skip to content

Commit 58aa18c

Browse files
committed
doc: add favicon to tutorial/manual
Since tutorial/manual files are stored on static.rust-lang.org, browsers try to fetch the favicon from there while it should be retrieved from the main domain.
1 parent 5a01dbe commit 58aa18c

File tree

2 files changed

+47
-25
lines changed

2 files changed

+47
-25
lines changed

doc/favicon.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<link rel="shortcut icon" href="http://www.rust-lang.org/favicon.ico" />

mk/docs.mk

Lines changed: 46 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,10 @@ doc/manual.inc: manual.inc
2828
@$(call E, cp: $@)
2929
$(Q)cp -a $< $@ 2> /dev/null
3030

31+
doc/favicon.inc: favicon.inc
32+
@$(call E, cp: $@)
33+
$(Q)cp -a $< $@ 2> /dev/null
34+
3135
ifeq ($(CFG_PANDOC),)
3236
$(info cfg: no pandoc found, omitting docs)
3337
NO_DOCS = 1
@@ -41,7 +45,8 @@ endif
4145
ifneq ($(NO_DOCS),1)
4246

4347
DOCS += doc/rust.html
44-
doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.inc
48+
doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.inc \
49+
doc/favicon.inc
4550
@$(call E, pandoc: $@)
4651
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
4752
"$(CFG_PANDOC)" \
@@ -50,6 +55,7 @@ doc/rust.html: rust.md doc/version_info.html doc/rust.css doc/manual.inc
5055
--number-sections \
5156
--from=markdown --to=html5 \
5257
--css=rust.css --include-in-header=doc/manual.inc \
58+
--include-in-header=doc/favicon.inc \
5359
--include-before-body=doc/version_info.html \
5460
--output=$@
5561

@@ -73,24 +79,12 @@ doc/rust.epub: rust.md doc/version_info.html doc/rust.css doc/manual.inc
7379
--section-divs \
7480
--number-sections \
7581
--from=markdown --to=epub \
76-
--css=rust.css --include-in-header=doc/manual.inc \
7782
--include-before-body=doc/version_info.html \
7883
--output=$@
7984

80-
81-
DOCS += doc/tutorial.tex
82-
doc/tutorial.tex: tutorial.md doc/version.md
83-
@$(call E, pandoc: $@)
84-
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
85-
"$(CFG_PANDOC)" \
86-
--standalone --toc \
87-
--number-sections \
88-
--include-before-body=doc/version.md \
89-
--from=markdown --to=latex \
90-
--output=$@
91-
9285
DOCS += doc/rustpkg.html
93-
doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css doc/manual.inc
86+
doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css doc/manual.inc \
87+
doc/favicon.inc
9488
@$(call E, pandoc: $@)
9589
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
9690
"$(CFG_PANDOC)" \
@@ -99,26 +93,40 @@ doc/rustpkg.html: rustpkg.md doc/version_info.html doc/rust.css doc/manual.inc
9993
--number-sections \
10094
--from=markdown --to=html5 \
10195
--css=rust.css --include-in-header=doc/manual.inc \
96+
--include-in-header=doc/favicon.inc \
10297
--include-before-body=doc/version_info.html \
10398
--output=$@
10499

105100
DOCS += doc/tutorial.html
106-
doc/tutorial.html: tutorial.md doc/version_info.html doc/rust.css
101+
doc/tutorial.html: tutorial.md doc/version_info.html doc/rust.css \
102+
doc/favicon.inc
107103
@$(call E, pandoc: $@)
108104
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
109105
$(CFG_PANDOC) --standalone --toc \
110106
--section-divs --number-sections \
111107
--from=markdown --to=html5 --css=rust.css \
108+
--include-in-header=doc/favicon.inc \
112109
--include-before-body=doc/version_info.html \
113110
--output=$@
114111

112+
DOCS += doc/tutorial.tex
113+
doc/tutorial.tex: tutorial.md doc/version.md
114+
@$(call E, pandoc: $@)
115+
$(Q)$(CFG_NODE) $(S)doc/prep.js $< | \
116+
"$(CFG_PANDOC)" \
117+
--standalone --toc \
118+
--number-sections \
119+
--include-before-body=doc/version.md \
120+
--from=markdown --to=latex \
121+
--output=$@
122+
115123
DOCS += doc/tutorial.epub
116124
doc/tutorial.epub: tutorial.md doc/version_info.html doc/rust.css
117125
@$(call E, pandoc: $@)
118126
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
119127
$(CFG_PANDOC) --standalone --toc \
120128
--section-divs --number-sections \
121-
--from=markdown --to=epub --css=rust.css \
129+
--from=markdown --to=epub \
122130
--include-before-body=doc/version_info.html \
123131
--output=$@
124132

@@ -134,73 +142,86 @@ doc/l10n/ja/tutorial.html: doc/l10n/ja/tutorial.md doc/version_info.html doc/rus
134142
--output=$@
135143

136144
DOCS += doc/tutorial-macros.html
137-
doc/tutorial-macros.html: tutorial-macros.md doc/version_info.html \
138-
doc/rust.css
145+
doc/tutorial-macros.html: tutorial-macros.md doc/version_info.html doc/rust.css \
146+
doc/favicon.inc
139147
@$(call E, pandoc: $@)
140148
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
141149
$(CFG_PANDOC) --standalone --toc \
142150
--section-divs --number-sections \
143151
--from=markdown --to=html5 --css=rust.css \
152+
--include-in-header=doc/favicon.inc \
144153
--include-before-body=doc/version_info.html \
145154
--output=$@
146155

147156
DOCS += doc/tutorial-container.html
148-
doc/tutorial-container.html: tutorial-container.md doc/version_info.html doc/rust.css
157+
doc/tutorial-container.html: tutorial-container.md doc/version_info.html doc/rust.css \
158+
doc/favicon.inc
149159
@$(call E, pandoc: $@)
150160
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
151161
$(CFG_PANDOC) --standalone --toc \
152162
--section-divs --number-sections \
153163
--from=markdown --to=html5 --css=rust.css \
164+
--include-in-header=doc/favicon.inc \
154165
--include-before-body=doc/version_info.html \
155166
--output=$@
156167

157168
DOCS += doc/tutorial-ffi.html
158-
doc/tutorial-ffi.html: tutorial-ffi.md doc/version_info.html doc/rust.css
169+
doc/tutorial-ffi.html: tutorial-ffi.md doc/version_info.html doc/rust.css \
170+
doc/favicon.inc
159171
@$(call E, pandoc: $@)
160172
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
161173
$(CFG_PANDOC) --standalone --toc \
162174
--section-divs --number-sections \
163175
--from=markdown --to=html5 --css=rust.css \
176+
--include-in-header=doc/favicon.inc \
164177
--include-before-body=doc/version_info.html \
165178
--output=$@
166179

167180
DOCS += doc/tutorial-borrowed-ptr.html
168-
doc/tutorial-borrowed-ptr.html: tutorial-borrowed-ptr.md doc/version_info.html doc/rust.css
181+
doc/tutorial-borrowed-ptr.html: tutorial-borrowed-ptr.md doc/version_info.html doc/rust.css \
182+
doc/favicon.inc
169183
@$(call E, pandoc: $@)
170184
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
171185
$(CFG_PANDOC) --standalone --toc \
172186
--section-divs --number-sections \
173187
--from=markdown --to=html5 --css=rust.css \
188+
--include-in-header=doc/favicon.inc \
174189
--include-before-body=doc/version_info.html \
175190
--output=$@
176191

177192
DOCS += doc/tutorial-tasks.html
178-
doc/tutorial-tasks.html: tutorial-tasks.md doc/version_info.html doc/rust.css
193+
doc/tutorial-tasks.html: tutorial-tasks.md doc/version_info.html doc/rust.css \
194+
doc/favicon.inc
179195
@$(call E, pandoc: $@)
180196
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
181197
$(CFG_PANDOC) --standalone --toc \
182198
--section-divs --number-sections \
183199
--from=markdown --to=html5 --css=rust.css \
200+
--include-in-header=doc/favicon.inc \
184201
--include-before-body=doc/version_info.html \
185202
--output=$@
186203

187204
DOCS += doc/tutorial-conditions.html
188-
doc/tutorial-conditions.html: tutorial-conditions.md doc/version_info.html doc/rust.css
205+
doc/tutorial-conditions.html: tutorial-conditions.md doc/version_info.html doc/rust.css \
206+
doc/favicon.inc
189207
@$(call E, pandoc: $@)
190208
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
191209
$(CFG_PANDOC) --standalone --toc \
192210
--section-divs --number-sections \
193211
--from=markdown --to=html5 --css=rust.css \
212+
--include-in-header=doc/favicon.inc \
194213
--include-before-body=doc/version_info.html \
195214
--output=$@
196215

197216
DOCS += doc/tutorial-rustpkg.html
198-
doc/tutorial-rustpkg.html: tutorial-rustpkg.md doc/version_info.html doc/rust.css
217+
doc/tutorial-rustpkg.html: tutorial-rustpkg.md doc/version_info.html doc/rust.css \
218+
doc/favicon.inc
199219
@$(call E, pandoc: $@)
200220
$(Q)$(CFG_NODE) $(S)doc/prep.js --highlight $< | \
201221
$(CFG_PANDOC) --standalone --toc \
202222
--section-divs --number-sections \
203223
--from=markdown --to=html5 --css=rust.css \
224+
--include-in-header=doc/favicon.inc \
204225
--include-before-body=doc/version_info.html \
205226
--output=$@
206227

0 commit comments

Comments
 (0)