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