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