1
- # Makefile for Sphinx documentation
1
+ # Minimal makefile for Sphinx documentation
2
2
#
3
3
4
4
# You can set these variables from the command line.
5
5
SPHINXOPTS =
6
6
SPHINXBUILD = sphinx-build
7
- PAPER =
7
+ SPHINXPROJ = Flask
8
+ SOURCEDIR = .
8
9
BUILDDIR = _build
9
10
10
- # Internal variables.
11
- PAPEROPT_a4 = -D latex_paper_size=a4
12
- PAPEROPT_letter = -D latex_paper_size=letter
13
- ALLSPHINXOPTS = -d $(BUILDDIR ) /doctrees $(PAPEROPT_$(PAPER ) ) $(SPHINXOPTS ) .
14
-
15
- .PHONY : help clean html dirhtml singlehtml pickle json htmlhelp qthelp epub latex changes linkcheck doctest
16
-
11
+ # Put it first so that "make" without argument is like "make help".
17
12
help :
18
- @echo " Please use \` make <target>' where <target> is one of"
19
- @echo " html to make standalone HTML files"
20
- @echo " dirhtml to make HTML files named index.html in directories"
21
- @echo " singlehtml to make a single large HTML file"
22
- @echo " pickle to make pickle files"
23
- @echo " json to make JSON files"
24
- @echo " htmlhelp to make HTML files and a HTML help project"
25
- @echo " qthelp to make HTML files and a qthelp project"
26
- @echo " devhelp to make HTML files and a Devhelp project"
27
- @echo " epub to make an epub"
28
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
29
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
30
- @echo " changes to make an overview of all changed/added/deprecated items"
31
- @echo " linkcheck to check all external links for integrity"
32
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
33
-
34
- clean :
35
- -rm -rf $(BUILDDIR ) /*
36
-
37
- html :
38
- $(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
39
- @echo
40
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
41
-
42
- dirhtml :
43
- $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
44
- @echo
45
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml."
46
-
47
- singlehtml :
48
- $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
49
- @echo
50
- @echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml."
51
-
52
- pickle :
53
- $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
54
- @echo
55
- @echo " Build finished; now you can process the pickle files."
56
-
57
- json :
58
- $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
59
- @echo
60
- @echo " Build finished; now you can process the JSON files."
61
-
62
- htmlhelp :
63
- $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
64
- @echo
65
- @echo " Build finished; now you can run HTML Help Workshop with the" \
66
- " .hhp project file in $( BUILDDIR) /htmlhelp."
67
-
68
- qthelp :
69
- $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
70
- @echo
71
- @echo " Build finished; now you can run " qcollectiongenerator" with the" \
72
- " .qhcp project file in $( BUILDDIR) /qthelp, like this:"
73
- @echo " # qcollectiongenerator $( BUILDDIR) /qthelp/Flask.qhcp"
74
- @echo " To view the help file:"
75
- @echo " # assistant -collectionFile $( BUILDDIR) /qthelp/Flask.qhc"
76
-
77
- devhelp :
78
- $(SPHINXBUILD ) -b devhelp $(ALLSPHINXOPTS ) _build/devhelp
79
- @echo
80
- @echo " Build finished."
81
- @echo " To view the help file:"
82
- @echo " # mkdir -p $$ HOME/.local/share/devhelp/Flask"
83
- @echo " # ln -s _build/devhelp $$ HOME/.local/share/devhelp/Flask"
84
- @echo " # devhelp"
85
-
86
- epub :
87
- $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
88
- @echo
89
- @echo " Build finished. The epub file is in $( BUILDDIR) /epub."
90
-
91
- latex :
92
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
93
- @echo
94
- @echo " Build finished; the LaTeX files are in $( BUILDDIR) /latex."
95
- @echo " Run \` make all-pdf' or \` make all-ps' in that directory to" \
96
- " run these through (pdf)latex."
97
-
98
- latexpdf : latex
99
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) _build/latex
100
- @echo " Running LaTeX files through pdflatex..."
101
- make -C _build/latex all-pdf
102
- @echo " pdflatex finished; the PDF files are in _build/latex."
103
-
104
- changes :
105
- $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
106
- @echo
107
- @echo " The overview file is in $( BUILDDIR) /changes."
13
+ @$(SPHINXBUILD ) -M help " $( SOURCEDIR) " " $( BUILDDIR) " $(SPHINXOPTS ) $(O )
108
14
109
- linkcheck :
110
- $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
111
- @echo
112
- @echo " Link check complete; look for any errors in the above output " \
113
- " or in $( BUILDDIR) /linkcheck/output.txt."
15
+ .PHONY : help Makefile
114
16
115
- doctest :
116
- $( SPHINXBUILD ) -b doctest $( ALLSPHINXOPTS ) $( BUILDDIR ) /doctest
117
- @echo " Testing of doctests in the sources finished, look at the " \
118
- " results in $( BUILDDIR) /doctest/output.txt. "
17
+ # Catch-all target: route all unknown targets to Sphinx using the new
18
+ # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19
+ % : Makefile
20
+ @ $( SPHINXBUILD ) -M $@ " $( SOURCEDIR ) " " $( BUILDDIR) " $( SPHINXOPTS ) $( O )
0 commit comments