-
Notifications
You must be signed in to change notification settings - Fork 6
/
Makefile
349 lines (286 loc) · 11.4 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
347
348
349
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@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 " gettext to make PO message catalogs"
@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)"
@echo ""
@echo " setup to install dependencies and configure the git repo"
@echo " setup_pip_requirements to install pip dependencies"
@echo " setup_git_remotes to configure the git repo"
@echo " build_setup to create a _build/html directory"
@echo " copy_sidebar_to_footer to copy _Sidebar.rest to _Footer.rest"
@echo " copy_sidebar_to_readme to copy _Sidebar.rest to README.rst"
@echo " copy_sidebar_to_home to copy _Sidebar.rest to _Home.rest"
@echo " copy_sidebars to copy _Sidebar.rest to Footer, README"
@echo " copy_sidebars_and_commit to copy sidebars and git commit"
@echo " commit to git commit"
@echo " pull to git pull from both repos: .wiki and gh-pages"
@echo " push to git push to both repos: .wiki and gh-pages"
@echo " gh-pages to overwrite the gh-pages branch with _build/html"
@echo ""
@echo " rst2html_all to build all .rest pages with rst2html"
@echo " build to build sidebars, rst2html_all, and html"
@echo ""
@echo " Example: make commit pull build gh-pages push"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/complexity.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/complexity.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/complexity"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/complexity"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/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) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/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) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
### wiki Makefile
.PHONY: default clean build \
build_setup \
rst2html_all \
copy_sidebar_to_footer \
copy_sidebar_to_home \
copy_sidebar_to_readme \
copy_sidebar_to_footer_and_commit \
copy_sidebars \
setup \
setup_pip_requirements \
setup_git_remotes \
commit \
pull \
push
WIKI_REPO_URL=github.com/westurner/tools
default: build
build_setup:
[ -d ./_build ] || mkdir -pv ./_build/
[ -d ./_build/html ] || mkdir -pv ./_build/html
rst2html_all: build_setup
find . -name '*.rest' -print0 \
| xargs -0 -I % rst2html.py % _build/html/%.html
copy_sidebar_to_footer:
echo '' > _Footer.rest
echo '`#top <#>`_' >> _Footer.rest
echo '' >> _Footer.rest
echo '*****' >> _Footer.rest
echo '' >> _Footer.rest
cat _Sidebar.rest >> _Footer.rest
copy_sidebar_to_home:
echo '' > Home.rest
echo 'Welcome to `<https://$(WIKI_REPO_URL)/wiki>`_' >> Home.rest
echo '' >> Home.rest
cat _Sidebar.rest >> Home.rest
copy_sidebar_to_readme: copy_sidebar_to_home
echo '' > README.rst
echo '===============' >> README.rst
echo 'westurner/tools' >> README.rst
echo '===============' >> README.rst
echo '' >> README.rst
cat Home.rest >> README.rst
copy_sidebars:
$(MAKE) copy_sidebar_to_footer
#$(MAKE) copy_sidebar_to_home
$(MAKE) copy_sidebar_to_readme
copy_sidebars_and_commit:
$(MAKE) copy_sidebars
git add Home.rest _Footer.rest
git commit _Footer.rest _Home.rest README.rst \
-m "DOC: Regenerate _Home, _Sidebar, _Footer, and README navigation"
STATIC:=./_static
LOCALJS=$(STATIC)/js/local.js
LOCALCSS=$(STATIC)/css/local.css
localjs:
echo '' > $(LOCALJS)
cat $(STATIC)/js/ga.js >> $(LOCALJS)
cat $(STATIC)/js/fix-tables.js >> $(LOCALJS)
cat $(STATIC)/js/newtab.js >> $(LOCALJS)
cat $(STATIC)/js/sidenav-affix.js >> $(LOCALJS)
cat $(STATIC)/js/jquery.scrollTo.js >> $(LOCALJS)
cat $(STATIC)/js/jquery.isonscreen.js >> $(LOCALJS)
cat $(STATIC)/js/sidenav-scrollto.js >> $(LOCALJS)
localcss:
echo '' > $(LOCALCSS)
cat $(STATIC)/css/custom.css >> $(LOCALCSS)
cat $(STATIC)/css/sidenav-scrollto.css >> $(LOCALCSS)
cat $(STATIC)/css/leftnavbar.css >> $(LOCALCSS)
cat $(STATIC)/css/wiki.css >> $(LOCALCSS)
BUILDDIR:=./_build
BUILDDIRHTML:=./_build/html
BUILDDIRSINGLEHTML:=./_build/singlehtml
localjs-live:
$(MAKE) localjs
cp -v ${LOCALJS} ${BUILDDIRHTML}/_static/js/local.js || true;
cp -v ${LOCALJS} ${BUILDDIRSINGLEHTML}/_static/js/local.js || true;
localcss-live:
$(MAKE) localcss
cp -v ${LOCALCSS} ${BUILDDIRHTML}/_static/css/local.css || true;
cp -v ${LOCALCSS} ${BUILDDIRSINGLEHTML}/_static/css/local.css || true;
local-live:
$(MAKE) localjs-live
$(MAKE) localcss-live
build: copy_sidebars rst2html_all localjs localcss html
docs: build
open:
websh.py ./_build/html/index.html || open ./_build/html/index.html
#clean:
# rm -rf ./_build
commit:
git commit
setup:
# setup install requirements
$(MAKE) setup_pip_requirements
setup_pip_requirements:
# install setup requirements with pip
pip install -r ./requirements.txt
setup_git_remotes:
# git remote set origin, wiki to WIKI_REPO_URL[.wiki.git]
# git clone ssh://git@$(WIKI_REPO_URL)
git remote remove origin || true
git remote add origin ssh://git@$(WIKI_REPO_URL)
git remote remove wiki || true
git remote add wiki ssh://git@$(WIKI_REPO_URL).wiki.git
pull:
# git pull from origin master, wiki master
git pull origin master
git pull wiki master
git fetch origin gh-pages
push:
# git push to origin master, wiki master, origin gh-pages
git push origin master
git push -f wiki master
git push -f origin gh-pages
gh-pages:
# Push docs to gh-pages branch with a .nojekyll file
ghp-import -n -p ./_build/html/
#ghp-import -n -p ./docs/_build/singlehtml/