|
160
|
1 @ECHO OFF
|
|
|
2
|
|
|
3 REM Command file for Sphinx documentation
|
|
|
4
|
|
|
5 if "%SPHINXBUILD%" == "" (
|
|
|
6 set SPHINXBUILD=sphinx-build
|
|
|
7 )
|
|
|
8 set BUILDDIR=build
|
|
|
9 set SRCDIR=src
|
|
|
10 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %SRCDIR%
|
|
|
11 set I18NSPHINXOPTS=%SPHINXOPTS% %SRCDIR%
|
|
|
12 if NOT "%PAPER%" == "" (
|
|
|
13 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
|
|
14 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
|
|
|
15 )
|
|
|
16
|
|
|
17 if "%1" == "" goto help
|
|
|
18
|
|
|
19 if "%1" == "help" (
|
|
|
20 :help
|
|
|
21 echo.Please use `make ^<target^>` where ^<target^> is one of
|
|
|
22 echo. html to make standalone HTML files
|
|
|
23 echo. dirhtml to make HTML files named index.html in directories
|
|
|
24 echo. singlehtml to make a single large HTML file
|
|
|
25 echo. pickle to make pickle files
|
|
|
26 echo. json to make JSON files
|
|
|
27 echo. htmlhelp to make HTML files and a HTML help project
|
|
|
28 echo. qthelp to make HTML files and a qthelp project
|
|
|
29 echo. devhelp to make HTML files and a Devhelp project
|
|
|
30 echo. epub to make an epub
|
|
|
31 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
|
|
|
32 echo. text to make text files
|
|
|
33 echo. man to make manual pages
|
|
|
34 echo. texinfo to make Texinfo files
|
|
|
35 echo. gettext to make PO message catalogs
|
|
|
36 echo. changes to make an overview over all changed/added/deprecated items
|
|
|
37 echo. xml to make Docutils-native XML files
|
|
|
38 echo. pseudoxml to make pseudoxml-XML files for display purposes
|
|
|
39 echo. linkcheck to check all external links for integrity
|
|
|
40 echo. doctest to run all doctests embedded in the documentation if enabled
|
|
|
41 goto end
|
|
|
42 )
|
|
|
43
|
|
|
44 if "%1" == "clean" (
|
|
|
45 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
|
|
46 del /q /s %BUILDDIR%\*
|
|
|
47 goto end
|
|
|
48 )
|
|
|
49
|
|
|
50
|
|
|
51 %SPHINXBUILD% 2> nul
|
|
|
52 if errorlevel 9009 (
|
|
|
53 echo.
|
|
|
54 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
|
|
|
55 echo.installed, then set the SPHINXBUILD environment variable to point
|
|
|
56 echo.to the full path of the 'sphinx-build' executable. Alternatively you
|
|
|
57 echo.may add the Sphinx directory to PATH.
|
|
|
58 echo.
|
|
|
59 echo.If you don't have Sphinx installed, grab it from
|
|
|
60 echo.http://sphinx-doc.org/
|
|
|
61 exit /b 1
|
|
|
62 )
|
|
|
63
|
|
|
64 if "%1" == "html" (
|
|
|
65 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
|
|
66 if errorlevel 1 exit /b 1
|
|
|
67 echo.
|
|
|
68 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
|
|
69 goto end
|
|
|
70 )
|
|
|
71
|
|
|
72 if "%1" == "dirhtml" (
|
|
|
73 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
|
|
74 if errorlevel 1 exit /b 1
|
|
|
75 echo.
|
|
|
76 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
|
|
77 goto end
|
|
|
78 )
|
|
|
79
|
|
|
80 if "%1" == "singlehtml" (
|
|
|
81 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
|
|
82 if errorlevel 1 exit /b 1
|
|
|
83 echo.
|
|
|
84 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
|
|
85 goto end
|
|
|
86 )
|
|
|
87
|
|
|
88 if "%1" == "pickle" (
|
|
|
89 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
|
|
90 if errorlevel 1 exit /b 1
|
|
|
91 echo.
|
|
|
92 echo.Build finished; now you can process the pickle files.
|
|
|
93 goto end
|
|
|
94 )
|
|
|
95
|
|
|
96 if "%1" == "json" (
|
|
|
97 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
|
|
98 if errorlevel 1 exit /b 1
|
|
|
99 echo.
|
|
|
100 echo.Build finished; now you can process the JSON files.
|
|
|
101 goto end
|
|
|
102 )
|
|
|
103
|
|
|
104 if "%1" == "htmlhelp" (
|
|
|
105 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
|
|
106 if errorlevel 1 exit /b 1
|
|
|
107 echo.
|
|
|
108 echo.Build finished; now you can run HTML Help Workshop with the ^
|
|
|
109 .hhp project file in %BUILDDIR%/htmlhelp.
|
|
|
110 goto end
|
|
|
111 )
|
|
|
112
|
|
|
113 if "%1" == "qthelp" (
|
|
|
114 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
|
|
115 if errorlevel 1 exit /b 1
|
|
|
116 echo.
|
|
|
117 echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
|
|
118 .qhcp project file in %BUILDDIR%/qthelp, like this:
|
|
|
119 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\libuv.qhcp
|
|
|
120 echo.To view the help file:
|
|
|
121 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\libuv.ghc
|
|
|
122 goto end
|
|
|
123 )
|
|
|
124
|
|
|
125 if "%1" == "devhelp" (
|
|
|
126 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
|
|
127 if errorlevel 1 exit /b 1
|
|
|
128 echo.
|
|
|
129 echo.Build finished.
|
|
|
130 goto end
|
|
|
131 )
|
|
|
132
|
|
|
133 if "%1" == "epub" (
|
|
|
134 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
|
|
135 if errorlevel 1 exit /b 1
|
|
|
136 echo.
|
|
|
137 echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
|
|
138 goto end
|
|
|
139 )
|
|
|
140
|
|
|
141 if "%1" == "latex" (
|
|
|
142 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
|
143 if errorlevel 1 exit /b 1
|
|
|
144 echo.
|
|
|
145 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
|
|
146 goto end
|
|
|
147 )
|
|
|
148
|
|
|
149 if "%1" == "latexpdf" (
|
|
|
150 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
|
151 cd %BUILDDIR%/latex
|
|
|
152 make all-pdf
|
|
|
153 cd %BUILDDIR%/..
|
|
|
154 echo.
|
|
|
155 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
|
|
156 goto end
|
|
|
157 )
|
|
|
158
|
|
|
159 if "%1" == "latexpdfja" (
|
|
|
160 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
|
161 cd %BUILDDIR%/latex
|
|
|
162 make all-pdf-ja
|
|
|
163 cd %BUILDDIR%/..
|
|
|
164 echo.
|
|
|
165 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
|
|
|
166 goto end
|
|
|
167 )
|
|
|
168
|
|
|
169 if "%1" == "text" (
|
|
|
170 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
|
|
171 if errorlevel 1 exit /b 1
|
|
|
172 echo.
|
|
|
173 echo.Build finished. The text files are in %BUILDDIR%/text.
|
|
|
174 goto end
|
|
|
175 )
|
|
|
176
|
|
|
177 if "%1" == "man" (
|
|
|
178 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
|
|
179 if errorlevel 1 exit /b 1
|
|
|
180 echo.
|
|
|
181 echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
|
|
182 goto end
|
|
|
183 )
|
|
|
184
|
|
|
185 if "%1" == "texinfo" (
|
|
|
186 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
|
|
|
187 if errorlevel 1 exit /b 1
|
|
|
188 echo.
|
|
|
189 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
|
|
|
190 goto end
|
|
|
191 )
|
|
|
192
|
|
|
193 if "%1" == "gettext" (
|
|
|
194 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
|
|
|
195 if errorlevel 1 exit /b 1
|
|
|
196 echo.
|
|
|
197 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
|
|
198 goto end
|
|
|
199 )
|
|
|
200
|
|
|
201 if "%1" == "changes" (
|
|
|
202 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
|
|
203 if errorlevel 1 exit /b 1
|
|
|
204 echo.
|
|
|
205 echo.The overview file is in %BUILDDIR%/changes.
|
|
|
206 goto end
|
|
|
207 )
|
|
|
208
|
|
|
209 if "%1" == "linkcheck" (
|
|
|
210 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
|
|
211 if errorlevel 1 exit /b 1
|
|
|
212 echo.
|
|
|
213 echo.Link check complete; look for any errors in the above output ^
|
|
|
214 or in %BUILDDIR%/linkcheck/output.txt.
|
|
|
215 goto end
|
|
|
216 )
|
|
|
217
|
|
|
218 if "%1" == "doctest" (
|
|
|
219 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
|
|
220 if errorlevel 1 exit /b 1
|
|
|
221 echo.
|
|
|
222 echo.Testing of doctests in the sources finished, look at the ^
|
|
|
223 results in %BUILDDIR%/doctest/output.txt.
|
|
|
224 goto end
|
|
|
225 )
|
|
|
226
|
|
|
227 if "%1" == "xml" (
|
|
|
228 %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
|
|
|
229 if errorlevel 1 exit /b 1
|
|
|
230 echo.
|
|
|
231 echo.Build finished. The XML files are in %BUILDDIR%/xml.
|
|
|
232 goto end
|
|
|
233 )
|
|
|
234
|
|
|
235 if "%1" == "pseudoxml" (
|
|
|
236 %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
|
|
|
237 if errorlevel 1 exit /b 1
|
|
|
238 echo.
|
|
|
239 echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
|
|
|
240 goto end
|
|
|
241 )
|
|
|
242
|
|
|
243 :end
|
