4
4
# You can set these variables from the command line.
5
5
SPHINXOPTS =
6
6
SPHINXBUILD = sphinx-build
7
- PAPER =
8
7
BUILDDIR = _build
9
8
10
9
# 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
- # the i18n builder cannot share the environment and doctrees with the others
15
- I18NSPHINXOPTS = $(PAPEROPT_$(PAPER ) ) $(SPHINXOPTS ) .
16
-
17
- .PHONY : help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
18
-
19
- help :
20
- @echo " Please use \` make <target>' where <target> is one of"
21
- @echo " html to make standalone HTML files"
22
- @echo " dirhtml to make HTML files named index.html in directories"
23
- @echo " singlehtml to make a single large HTML file"
24
- @echo " pickle to make pickle files"
25
- @echo " json to make JSON files"
26
- @echo " htmlhelp to make HTML files and a HTML help project"
27
- @echo " qthelp to make HTML files and a qthelp project"
28
- @echo " devhelp to make HTML files and a Devhelp project"
29
- @echo " epub to make an epub"
30
- @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
31
- @echo " latexpdf to make LaTeX files and run them through pdflatex"
32
- @echo " text to make text files"
33
- @echo " man to make manual pages"
34
- @echo " texinfo to make Texinfo files"
35
- @echo " info to make Texinfo files and run them through makeinfo"
36
- @echo " gettext to make PO message catalogs"
37
- @echo " changes to make an overview of all changed/added/deprecated items"
38
- @echo " linkcheck to check all external links for integrity"
39
- @echo " doctest to run all doctests embedded in the documentation (if enabled)"
40
-
41
- clean :
42
- -rm -rf $(BUILDDIR ) /*
10
+ ALLSPHINXOPTS = -d $(BUILDDIR ) /doctrees $(SPHINXOPTS ) .
43
11
12
+ .PHONY : html
44
13
html :
45
14
$(SPHINXBUILD ) -b html $(ALLSPHINXOPTS ) $(BUILDDIR ) /html
46
15
sh munge_links.sh $(BUILDDIR ) /html
47
16
@echo
48
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
49
-
50
- dirhtml :
51
- $(SPHINXBUILD ) -b dirhtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /dirhtml
52
- sh munge_links.sh $(BUILDDIR ) /dirhtml
53
- @echo
54
- @echo " Build finished. The HTML pages are in $( BUILDDIR) /dirhtml."
55
-
56
- singlehtml :
57
- $(SPHINXBUILD ) -b singlehtml $(ALLSPHINXOPTS ) $(BUILDDIR ) /singlehtml
58
- sh munge_links.sh $(BUILDDIR ) /singlehtml
59
- @echo
60
- @echo " Build finished. The HTML page is in $( BUILDDIR) /singlehtml."
61
-
62
- pickle :
63
- $(SPHINXBUILD ) -b pickle $(ALLSPHINXOPTS ) $(BUILDDIR ) /pickle
64
- @echo
65
- @echo " Build finished; now you can process the pickle files."
66
-
67
- json :
68
- $(SPHINXBUILD ) -b json $(ALLSPHINXOPTS ) $(BUILDDIR ) /json
69
- @echo
70
- @echo " Build finished; now you can process the JSON files."
71
-
72
- htmlhelp :
73
- $(SPHINXBUILD ) -b htmlhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /htmlhelp
74
- @echo
75
- @echo " Build finished; now you can run HTML Help Workshop with the" \
76
- " .hhp project file in $( BUILDDIR) /htmlhelp."
77
-
78
- qthelp :
79
- $(SPHINXBUILD ) -b qthelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /qthelp
80
- @echo
81
- @echo " Build finished; now you can run " qcollectiongenerator" with the" \
82
- " .qhcp project file in $( BUILDDIR) /qthelp, like this:"
83
- @echo " # qcollectiongenerator $( BUILDDIR) /qthelp/SplunkPythonSDK.qhcp"
84
- @echo " To view the help file:"
85
- @echo " # assistant -collectionFile $( BUILDDIR) /qthelp/SplunkPythonSDK.qhc"
86
-
87
- devhelp :
88
- $(SPHINXBUILD ) -b devhelp $(ALLSPHINXOPTS ) $(BUILDDIR ) /devhelp
89
- @echo
90
- @echo " Build finished."
91
- @echo " To view the help file:"
92
- @echo " # mkdir -p $$ HOME/.local/share/devhelp/SplunkPythonSDK"
93
- @echo " # ln -s $( BUILDDIR) /devhelp $$ HOME/.local/share/devhelp/SplunkPythonSDK"
94
- @echo " # devhelp"
95
-
96
- epub :
97
- $(SPHINXBUILD ) -b epub $(ALLSPHINXOPTS ) $(BUILDDIR ) /epub
98
- @echo
99
- @echo " Build finished. The epub file is in $( BUILDDIR) /epub."
100
-
101
- latex :
102
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
103
- @echo
104
- @echo " Build finished; the LaTeX files are in $( BUILDDIR) /latex."
105
- @echo " Run \` make' in that directory to run these through (pdf)latex" \
106
- " (use \` make latexpdf' here to do that automatically)."
107
-
108
- latexpdf :
109
- $(SPHINXBUILD ) -b latex $(ALLSPHINXOPTS ) $(BUILDDIR ) /latex
110
- @echo " Running LaTeX files through pdflatex..."
111
- $(MAKE ) -C $(BUILDDIR ) /latex all-pdf
112
- @echo " pdflatex finished; the PDF files are in $( BUILDDIR) /latex."
113
-
114
- text :
115
- $(SPHINXBUILD ) -b text $(ALLSPHINXOPTS ) $(BUILDDIR ) /text
116
- @echo
117
- @echo " Build finished. The text files are in $( BUILDDIR) /text."
118
-
119
- man :
120
- $(SPHINXBUILD ) -b man $(ALLSPHINXOPTS ) $(BUILDDIR ) /man
121
- @echo
122
- @echo " Build finished. The manual pages are in $( BUILDDIR) /man."
123
-
124
- texinfo :
125
- $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
126
- @echo
127
- @echo " Build finished. The Texinfo files are in $( BUILDDIR) /texinfo."
128
- @echo " Run \` make' in that directory to run these through makeinfo" \
129
- " (use \` make info' here to do that automatically)."
130
-
131
- info :
132
- $(SPHINXBUILD ) -b texinfo $(ALLSPHINXOPTS ) $(BUILDDIR ) /texinfo
133
- @echo " Running Texinfo files through makeinfo..."
134
- make -C $(BUILDDIR ) /texinfo info
135
- @echo " makeinfo finished; the Info files are in $( BUILDDIR) /texinfo."
136
-
137
- gettext :
138
- $(SPHINXBUILD ) -b gettext $(I18NSPHINXOPTS ) $(BUILDDIR ) /locale
139
- @echo
140
- @echo " Build finished. The message catalogs are in $( BUILDDIR) /locale."
141
-
142
- changes :
143
- $(SPHINXBUILD ) -b changes $(ALLSPHINXOPTS ) $(BUILDDIR ) /changes
144
- @echo
145
- @echo " The overview file is in $( BUILDDIR) /changes."
146
-
147
- linkcheck :
148
- $(SPHINXBUILD ) -b linkcheck $(ALLSPHINXOPTS ) $(BUILDDIR ) /linkcheck
149
- @echo
150
- @echo " Link check complete; look for any errors in the above output " \
151
- " or in $( BUILDDIR) /linkcheck/output.txt."
152
-
153
- doctest :
154
- $(SPHINXBUILD ) -b doctest $(ALLSPHINXOPTS ) $(BUILDDIR ) /doctest
155
- @echo " Testing of doctests in the sources finished, look at the " \
156
- " results in $( BUILDDIR) /doctest/output.txt."
17
+ @echo " Build finished. The HTML pages are in $( BUILDDIR) /html."
0 commit comments