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
|
# Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html web pickle htmlhelp latex changes linkcheck install
all: html
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " pickle to make pickle files (usable by e.g. sphinx-web)"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " changes to make an overview over all changed/added/deprecated items"
@echo " linkcheck to check all external links for integrity"
clean:
-rm -rf html doctrees pickle htmlhelp latex changes linkcheck
html:
mkdir -p html doctrees
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) html
@echo
@echo "Build finished. The HTML pages are in html."
pickle:
mkdir -p pickle doctrees
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) pickle
@echo
@echo "Build finished; now you can process the pickle files or run"
@echo " sphinx-web pickle"
@echo "to start the sphinx-web server."
web: pickle
htmlhelp:
mkdir -p htmlhelp doctrees
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in htmlhelp."
latex:
mkdir -p latex doctrees
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) latex
@echo
@echo "Build finished; the LaTeX files are in .build/latex."
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
"run these through (pdf)latex."
changes:
mkdir -p changes doctrees
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) changes
@echo
@echo "The overview file is in changes."
linkcheck:
mkdir -p linkcheck doctrees
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in linkcheck/output.txt."
gh-pages: html
cd gh-pages; git pull --rebase; cd ..; cp -r ./html/* gh-pages
publish: gh-pages
cd gh-pages; git commit -a; git push; cd ..
|
