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