-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile
347 lines (297 loc) · 13.2 KB
/
Makefile
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
# Makefile for Sphinx documentation
#
# You can set these variables from the command line
LANG = en
JOBS = 1
SPHINXBUILD = sphinx-build
SPHINXINTL = sphinx-intl
PAPER =
SOURCEDIR = source
RESOURCEDIR = resources
BUILDDIR = output/html
LBUILDDIR = $(BUILDDIR)/$(LANG)
# using the -A flag, we create a python variable named 'language', which
# we then can use in html templates to create language dependent switches
SPHINXOPTS = -D language=$(LANG) -A language=$(LANG) $(SOURCEDIR)
PYTHON = python3
LANGUAGES := en $(patsubst en,,$(subst i18n/,,$(wildcard i18n/*)))
# needed for python2 -> python3 migration?
export LC_ALL=C.UTF-8
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(LBUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS)
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) i18n/pot
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext schedule
help:
@echo " "
@echo "Please use \`make <target> LANG=xx' where xx=language code and <target> is one of:"
@echo " html to build the website as html for enlish only"
@echo " world to create the website for ALL available languages"
@echo " clean to clean up all intermediate files"
@echo " springclean to also remove build output besides normal clean"
@echo " createlang to create (mostly directories) for a new language"
@echo " pretranslate to gather all strings from sources, put in .pot files"
@echo " AND merge them with available .po files"
@echo " transifex_push (only for transifex Maintainers!): renew source files and push to transifex"
@echo " venvupdate to setup or update a virtualenv with sphinx in sphinx/"
@echo " "
@echo "OPTION: use LANG=xx to do it only for one language, eg: make html LANG=de"
@echo " "
# @echo " gettext to make PO message catalogs"
# @echo " dirhtml to make HTML files named index.html in directories"
# @echo " singlehtml to make a single large HTML file"
# @echo " pickle to make pickle files"
# @echo " json to make JSON files"
# @echo " htmlhelp to make HTML files and a HTML help project"
# @echo " qthelp to make HTML files and a qthelp project"
# @echo " devhelp to make HTML files and a Devhelp project"
# @echo " epub to make an epub"
# @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
# @echo " latexpdf to make LaTeX files and run them through pdflatex"
# @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
# @echo " text to make text files"
# @echo " man to make manual pages"
# @echo " texinfo to make Texinfo files"
# @echo " info to make Texinfo files and run them through makeinfo"
# @echo " changes to make an overview of all changed/added/deprecated items"
# @echo " xml to make Docutils-native XML files"
# @echo " pseudoxml to make pseudoxml-XML files for display purposes"
# @echo " linkcheck to check all external links for integrity"
# @echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(SOURCEDIR)/static
define langhtml
html-$(1): html-en
make LANG=$(1) p-html >$(1).log; r=$$$$?; echo R:$$$$r >>$(1).log; grep -Hn "" $(1).log; exit $$$$r
flock jdupes.lock jdupes -Lr $(BUILDDIR)
endef
$(foreach l,$(LANGUAGES),$(eval $(call langhtml,$(l))))
html-all: localizeresources $(foreach l,$(LANGUAGES),html-$(l))
springclean: clean
# something in i18n/pot dir creates havoc when using gettext: remove it
rm -rf i18n/pot
rm -rf i18n/*/LC_MESSAGES/docs/*/
rm -rf $(LBUILDDIR)/*
rm -f $(SOURCEDIR)/docs_conf.py*
rm -rf $(SOURCEDIR)/docs/*/
# all .mo files
find i18n/*/LC_MESSAGES/ -type f -name '*.mo' -delete
# remove all resources from source/static directory
# copy english resources from resources/en to source/static directory
# IF we have a localized build (LANG != en) then
# overwrite with potentially available LANG resources by
# copy LANG resources from resources/LANG to source/static directory
# TODO: check if LANG != en, for now: unnecessary copy for english
localizeresources: clean
@echo
@echo "Removing all static content from $(SOURCEDIR)/static."
rm -rf $(SOURCEDIR)/static
@echo "Copy 'en' (base) static content to $(SOURCEDIR)/static."
mkdir $(SOURCEDIR)/static
# historically the images for the docs sub project are not in a separate docs folder
# that is why we copy site (to site) and docs/* into root in separate steps
cp -r $(RESOURCEDIR)/en/site $(SOURCEDIR)/static
@if [ -d "$(RESOURCEDIR)/en/docs" ]; then \
cp -r $(RESOURCEDIR)/en/docs/* $(SOURCEDIR)/static; \
fi
@echo "Copy localized '$(LANG)' static content to $(SOURCEDIR)/static."
@if [ -d "$(RESOURCEDIR)/$(LANG)/site" ]; then \
cp -r $(RESOURCEDIR)/$(LANG)/site $(SOURCEDIR)/static; \
fi
@if [ -d "$(RESOURCEDIR)/$(LANG)/docs" ]; then \
cp -r $(RESOURCEDIR)/$(LANG)/docs/* $(SOURCEDIR)/static; \
fi
html: localizeresources p-html
p-html: output/html/version.txt output/html/version-ltr.txt source/site/getinvolved/development/schedule.inc source/schedule.py $(BUILDDIR)/schedule.ics
$(SPHINXINTL) --config $(SOURCEDIR)/conf.py build --language=$(LANG)
# ONLY in the english version run in nit-picky mode, so source errors/warnings will fail in CI
# -n Run in nit-picky mode. Currently, this generates warnings for all missing references.
# -W Turn warnings into errors. This means that the build stops at the first warning and sphinx-build exits with exit status 1.
@if [ $(LANG) != "en" ]; then \
$(SPHINXBUILD) -j$(JOBS) -b html $(ALLSPHINXOPTS) $(LBUILDDIR); \
else \
$(SPHINXBUILD) -n -W -j$(JOBS) -b html $(ALLSPHINXOPTS) $(LBUILDDIR); \
fi
@echo
@echo "Build finished. The HTML pages for '$(LANG)' are in $(LBUILDDIR)."
output/html/version.txt output/html/version-ltr.txt: source/conf.py source/schedule.py
mkdir -p $(LBUILDDIR)
$(PYTHON) scripts/mkversion.py
$(BUILDDIR)/schedule.ics: source/schedule.ics
mkdir -p $(BUILDDIR)
cp -u $< $@
full: springclean
@-if [ $(LANG) = "en" ]; then \
echo; \
else \
echo; \
echo Pulling $$LANG from transifex; \
tx --root-config .transifexrc pull --minimum-perc=1 --skip -f -l $$LANG; \
fi
make html
world: full
all:
@echo
@echo Building html for the following languages: $(LANGUAGES)
@echo
@echo Starting with pulling all translations from transifex
# --minimum-perc=1 so only files which have at least 1% translation are pulled
# -f to force, --skip to not stop with errors
tx --root-config .transifexrc pull --minimum-perc=1 --skip -f
# after build quickly rename old live dir, mv output to live dir and then remove old dir
@for LANG in $(LANGUAGES) ; do \
make LANG=$$LANG html; \
mkdir -p live/html/$$LANG; \
mv live/html/$$LANG live/html/$$LANG.old; \
mv output/html/$$LANG live/html/; \
rm -rf live/html/$$LANG.old; \
done
createlang: springclean
@echo Creating a new Language: $(LANG)
mkdir -p i18n/${LANG}
mkdir -p resources/${LANG}
cp resources/en/README resources/${LANG}
cp i18n/en/README i18n/${LANG}
pretranslate: gettext
@echo "Generating the pot files for the QGIS-Website project (NOT including the docs)"
$(SPHINXINTL) update -p i18n/pot -l $(LANG)
gettext:
# something in i18n/pot dir creates havoc when using gettext: remove it
rm -rf i18n/pot
# be sure to remove possible available docs sources:
rm -rf $(SOURCEDIR)/docs/*/
# remove donors.inc (no translation necessary)
rm -f source/site/about/donors.inc
$(SPHINXBUILD) -j$(JOBS) -b gettext $(I18NSPHINXOPTS)
git checkout source/site/about/donors.inc
@echo
@echo "Build finished. The message catalogs are in $(LBUILDDIR)/locale."
# ONLY to be done by a transifex Maintainer for the project, as it overwrites
# the english source resources
# 1) make springclean (removing all building cruft)
# 2) make pretranslate (getting all strings from sources and create new pot files)
# 3) scripts/create_transifex_resources.sh (will update the .tx/config file with new resources)
# 4) tx --root-config .transifexrc push -fs --no-interactive (push the source (-f) files forcing (-f) overwriting the ones their without asking (--no-interactive)
transifex_push:
make springclean
make pretranslate
################################################################################
#
# rules below either not tested or not working yet
# plz check and/or fix
#
################################################################################
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(LBUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(LBUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(LBUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(LBUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(LBUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(LBUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(LBUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(LBUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(LBUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(LBUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(LBUILDDIR)/qthelp/QGISWebsite.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(LBUILDDIR)/qthelp/QGISWebsite.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(LBUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/QGISWebsite"
@echo "# ln -s $(LBUILDDIR)/devhelp $$HOME/.local/share/devhelp/QGISWebsite"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(LBUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(LBUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(LBUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(LBUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(LBUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(LBUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(LBUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(LBUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(LBUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(LBUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(LBUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(LBUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(LBUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(LBUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(LBUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(LBUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(LBUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(LBUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(LBUILDDIR)/texinfo."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(LBUILDDIR)/changes
@echo
@echo "The overview file is in $(LBUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(LBUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(LBUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(LBUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(LBUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(LBUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(LBUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(LBUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(LBUILDDIR)/pseudoxml."
source/site/getinvolved/development/schedule.inc source/schedule.py source/schedule.ics:
$(PYTHON) scripts/update-schedule.py
clearschedule: venvupdate
$(RM) source/site/getinvolved/development/schedule.inc source/schedule.py
schedule: clearschedule source/schedule.py
git pull --autostash --rebase
git commit -a -m "Update for $(shell sed -ne "s/^release = '\\(.*\\)'/\1/p" source/schedule.py)/$(shell sed -ne "s/^ltrrelease = '\\(.*\\)'/\\1/p" source/schedule.py) point releases"
style: themes/qgis-theme/static/qgis-style.css
themes/qgis-theme/static/qgis-style.css: themes/qgis-theme/static/qgis-style.less
lessc $< $@
yui-compressor -o $@ $@
venvupdate:
ifneq ($(VIRTUAL_ENV),)
[ -d sphinx ] || $(PYTHON) -m virtualenv sphinx; . sphinx/bin/activate; pip install -U -r REQUIREMENTS.txt
endif