Statistics
| Branch: | Tag: | Revision:

root / docs / make.bat @ 126f8f4e

History | View | Annotate | Download (5 kB)

1 126f8f4e Dimitris Aragiorgis
@ECHO OFF
2 126f8f4e Dimitris Aragiorgis
3 126f8f4e Dimitris Aragiorgis
REM Command file for Sphinx documentation
4 126f8f4e Dimitris Aragiorgis
5 126f8f4e Dimitris Aragiorgis
if "%SPHINXBUILD%" == "" (
6 126f8f4e Dimitris Aragiorgis
	set SPHINXBUILD=sphinx-build
7 126f8f4e Dimitris Aragiorgis
)
8 126f8f4e Dimitris Aragiorgis
set BUILDDIR=_build
9 126f8f4e Dimitris Aragiorgis
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10 126f8f4e Dimitris Aragiorgis
set I18NSPHINXOPTS=%SPHINXOPTS% .
11 126f8f4e Dimitris Aragiorgis
if NOT "%PAPER%" == "" (
12 126f8f4e Dimitris Aragiorgis
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 126f8f4e Dimitris Aragiorgis
	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14 126f8f4e Dimitris Aragiorgis
)
15 126f8f4e Dimitris Aragiorgis
16 126f8f4e Dimitris Aragiorgis
if "%1" == "" goto help
17 126f8f4e Dimitris Aragiorgis
18 126f8f4e Dimitris Aragiorgis
if "%1" == "help" (
19 126f8f4e Dimitris Aragiorgis
	:help
20 126f8f4e Dimitris Aragiorgis
	echo.Please use `make ^<target^>` where ^<target^> is one of
21 126f8f4e Dimitris Aragiorgis
	echo.  html       to make standalone HTML files
22 126f8f4e Dimitris Aragiorgis
	echo.  dirhtml    to make HTML files named index.html in directories
23 126f8f4e Dimitris Aragiorgis
	echo.  singlehtml to make a single large HTML file
24 126f8f4e Dimitris Aragiorgis
	echo.  pickle     to make pickle files
25 126f8f4e Dimitris Aragiorgis
	echo.  json       to make JSON files
26 126f8f4e Dimitris Aragiorgis
	echo.  htmlhelp   to make HTML files and a HTML help project
27 126f8f4e Dimitris Aragiorgis
	echo.  qthelp     to make HTML files and a qthelp project
28 126f8f4e Dimitris Aragiorgis
	echo.  devhelp    to make HTML files and a Devhelp project
29 126f8f4e Dimitris Aragiorgis
	echo.  epub       to make an epub
30 126f8f4e Dimitris Aragiorgis
	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31 126f8f4e Dimitris Aragiorgis
	echo.  text       to make text files
32 126f8f4e Dimitris Aragiorgis
	echo.  man        to make manual pages
33 126f8f4e Dimitris Aragiorgis
	echo.  texinfo    to make Texinfo files
34 126f8f4e Dimitris Aragiorgis
	echo.  gettext    to make PO message catalogs
35 126f8f4e Dimitris Aragiorgis
	echo.  changes    to make an overview over all changed/added/deprecated items
36 126f8f4e Dimitris Aragiorgis
	echo.  linkcheck  to check all external links for integrity
37 126f8f4e Dimitris Aragiorgis
	echo.  doctest    to run all doctests embedded in the documentation if enabled
38 126f8f4e Dimitris Aragiorgis
	goto end
39 126f8f4e Dimitris Aragiorgis
)
40 126f8f4e Dimitris Aragiorgis
41 126f8f4e Dimitris Aragiorgis
if "%1" == "clean" (
42 126f8f4e Dimitris Aragiorgis
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43 126f8f4e Dimitris Aragiorgis
	del /q /s %BUILDDIR%\*
44 126f8f4e Dimitris Aragiorgis
	goto end
45 126f8f4e Dimitris Aragiorgis
)
46 126f8f4e Dimitris Aragiorgis
47 126f8f4e Dimitris Aragiorgis
if "%1" == "html" (
48 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
50 126f8f4e Dimitris Aragiorgis
	echo.
51 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
52 126f8f4e Dimitris Aragiorgis
	goto end
53 126f8f4e Dimitris Aragiorgis
)
54 126f8f4e Dimitris Aragiorgis
55 126f8f4e Dimitris Aragiorgis
if "%1" == "dirhtml" (
56 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
58 126f8f4e Dimitris Aragiorgis
	echo.
59 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
60 126f8f4e Dimitris Aragiorgis
	goto end
61 126f8f4e Dimitris Aragiorgis
)
62 126f8f4e Dimitris Aragiorgis
63 126f8f4e Dimitris Aragiorgis
if "%1" == "singlehtml" (
64 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
66 126f8f4e Dimitris Aragiorgis
	echo.
67 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
68 126f8f4e Dimitris Aragiorgis
	goto end
69 126f8f4e Dimitris Aragiorgis
)
70 126f8f4e Dimitris Aragiorgis
71 126f8f4e Dimitris Aragiorgis
if "%1" == "pickle" (
72 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
74 126f8f4e Dimitris Aragiorgis
	echo.
75 126f8f4e Dimitris Aragiorgis
	echo.Build finished; now you can process the pickle files.
76 126f8f4e Dimitris Aragiorgis
	goto end
77 126f8f4e Dimitris Aragiorgis
)
78 126f8f4e Dimitris Aragiorgis
79 126f8f4e Dimitris Aragiorgis
if "%1" == "json" (
80 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
82 126f8f4e Dimitris Aragiorgis
	echo.
83 126f8f4e Dimitris Aragiorgis
	echo.Build finished; now you can process the JSON files.
84 126f8f4e Dimitris Aragiorgis
	goto end
85 126f8f4e Dimitris Aragiorgis
)
86 126f8f4e Dimitris Aragiorgis
87 126f8f4e Dimitris Aragiorgis
if "%1" == "htmlhelp" (
88 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
90 126f8f4e Dimitris Aragiorgis
	echo.
91 126f8f4e Dimitris Aragiorgis
	echo.Build finished; now you can run HTML Help Workshop with the ^
92 126f8f4e Dimitris Aragiorgis
.hhp project file in %BUILDDIR%/htmlhelp.
93 126f8f4e Dimitris Aragiorgis
	goto end
94 126f8f4e Dimitris Aragiorgis
)
95 126f8f4e Dimitris Aragiorgis
96 126f8f4e Dimitris Aragiorgis
if "%1" == "qthelp" (
97 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
99 126f8f4e Dimitris Aragiorgis
	echo.
100 126f8f4e Dimitris Aragiorgis
	echo.Build finished; now you can run "qcollectiongenerator" with the ^
101 126f8f4e Dimitris Aragiorgis
.qhcp project file in %BUILDDIR%/qthelp, like this:
102 126f8f4e Dimitris Aragiorgis
	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\snf-network.qhcp
103 126f8f4e Dimitris Aragiorgis
	echo.To view the help file:
104 126f8f4e Dimitris Aragiorgis
	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\snf-network.ghc
105 126f8f4e Dimitris Aragiorgis
	goto end
106 126f8f4e Dimitris Aragiorgis
)
107 126f8f4e Dimitris Aragiorgis
108 126f8f4e Dimitris Aragiorgis
if "%1" == "devhelp" (
109 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
111 126f8f4e Dimitris Aragiorgis
	echo.
112 126f8f4e Dimitris Aragiorgis
	echo.Build finished.
113 126f8f4e Dimitris Aragiorgis
	goto end
114 126f8f4e Dimitris Aragiorgis
)
115 126f8f4e Dimitris Aragiorgis
116 126f8f4e Dimitris Aragiorgis
if "%1" == "epub" (
117 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
119 126f8f4e Dimitris Aragiorgis
	echo.
120 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The epub file is in %BUILDDIR%/epub.
121 126f8f4e Dimitris Aragiorgis
	goto end
122 126f8f4e Dimitris Aragiorgis
)
123 126f8f4e Dimitris Aragiorgis
124 126f8f4e Dimitris Aragiorgis
if "%1" == "latex" (
125 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
127 126f8f4e Dimitris Aragiorgis
	echo.
128 126f8f4e Dimitris Aragiorgis
	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
129 126f8f4e Dimitris Aragiorgis
	goto end
130 126f8f4e Dimitris Aragiorgis
)
131 126f8f4e Dimitris Aragiorgis
132 126f8f4e Dimitris Aragiorgis
if "%1" == "text" (
133 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
135 126f8f4e Dimitris Aragiorgis
	echo.
136 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The text files are in %BUILDDIR%/text.
137 126f8f4e Dimitris Aragiorgis
	goto end
138 126f8f4e Dimitris Aragiorgis
)
139 126f8f4e Dimitris Aragiorgis
140 126f8f4e Dimitris Aragiorgis
if "%1" == "man" (
141 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
143 126f8f4e Dimitris Aragiorgis
	echo.
144 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The manual pages are in %BUILDDIR%/man.
145 126f8f4e Dimitris Aragiorgis
	goto end
146 126f8f4e Dimitris Aragiorgis
)
147 126f8f4e Dimitris Aragiorgis
148 126f8f4e Dimitris Aragiorgis
if "%1" == "texinfo" (
149 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
151 126f8f4e Dimitris Aragiorgis
	echo.
152 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
153 126f8f4e Dimitris Aragiorgis
	goto end
154 126f8f4e Dimitris Aragiorgis
)
155 126f8f4e Dimitris Aragiorgis
156 126f8f4e Dimitris Aragiorgis
if "%1" == "gettext" (
157 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
159 126f8f4e Dimitris Aragiorgis
	echo.
160 126f8f4e Dimitris Aragiorgis
	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
161 126f8f4e Dimitris Aragiorgis
	goto end
162 126f8f4e Dimitris Aragiorgis
)
163 126f8f4e Dimitris Aragiorgis
164 126f8f4e Dimitris Aragiorgis
if "%1" == "changes" (
165 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
167 126f8f4e Dimitris Aragiorgis
	echo.
168 126f8f4e Dimitris Aragiorgis
	echo.The overview file is in %BUILDDIR%/changes.
169 126f8f4e Dimitris Aragiorgis
	goto end
170 126f8f4e Dimitris Aragiorgis
)
171 126f8f4e Dimitris Aragiorgis
172 126f8f4e Dimitris Aragiorgis
if "%1" == "linkcheck" (
173 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
175 126f8f4e Dimitris Aragiorgis
	echo.
176 126f8f4e Dimitris Aragiorgis
	echo.Link check complete; look for any errors in the above output ^
177 126f8f4e Dimitris Aragiorgis
or in %BUILDDIR%/linkcheck/output.txt.
178 126f8f4e Dimitris Aragiorgis
	goto end
179 126f8f4e Dimitris Aragiorgis
)
180 126f8f4e Dimitris Aragiorgis
181 126f8f4e Dimitris Aragiorgis
if "%1" == "doctest" (
182 126f8f4e Dimitris Aragiorgis
	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183 126f8f4e Dimitris Aragiorgis
	if errorlevel 1 exit /b 1
184 126f8f4e Dimitris Aragiorgis
	echo.
185 126f8f4e Dimitris Aragiorgis
	echo.Testing of doctests in the sources finished, look at the ^
186 126f8f4e Dimitris Aragiorgis
results in %BUILDDIR%/doctest/output.txt.
187 126f8f4e Dimitris Aragiorgis
	goto end
188 126f8f4e Dimitris Aragiorgis
)
189 126f8f4e Dimitris Aragiorgis
190 126f8f4e Dimitris Aragiorgis
:end