Statistics
| Branch: | Tag: | Revision:

root / docs / make.bat @ c27d829e

History | View | Annotate | Download (5 kB)

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