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