|
97
|
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 if NOT "%PAPER%" == "" (
|
|
|
11 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
|
|
|
12 )
|
|
|
13
|
|
|
14 if "%1" == "" goto help
|
|
|
15
|
|
|
16 if "%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. gettext to make PO message catalogs
|
|
|
32 echo. changes to make an overview over all changed/added/deprecated items
|
|
|
33 echo. linkcheck to check all external links for integrity
|
|
|
34 echo. doctest to run all doctests embedded in the documentation if enabled
|
|
|
35 goto end
|
|
|
36 )
|
|
|
37
|
|
|
38 if "%1" == "clean" (
|
|
|
39 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
|
|
|
40 del /q /s %BUILDDIR%\*
|
|
|
41 goto end
|
|
|
42 )
|
|
|
43
|
|
|
44 if "%1" == "html" (
|
|
|
45 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
|
|
|
46 echo.
|
|
|
47 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
|
|
|
48 goto end
|
|
|
49 )
|
|
|
50
|
|
|
51 if "%1" == "dirhtml" (
|
|
|
52 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
|
|
|
53 echo.
|
|
|
54 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
|
|
|
55 goto end
|
|
|
56 )
|
|
|
57
|
|
|
58 if "%1" == "singlehtml" (
|
|
|
59 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
|
|
|
60 echo.
|
|
|
61 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
|
|
|
62 goto end
|
|
|
63 )
|
|
|
64
|
|
|
65 if "%1" == "pickle" (
|
|
|
66 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
|
|
|
67 echo.
|
|
|
68 echo.Build finished; now you can process the pickle files.
|
|
|
69 goto end
|
|
|
70 )
|
|
|
71
|
|
|
72 if "%1" == "json" (
|
|
|
73 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
|
|
|
74 echo.
|
|
|
75 echo.Build finished; now you can process the JSON files.
|
|
|
76 goto end
|
|
|
77 )
|
|
|
78
|
|
|
79 if "%1" == "htmlhelp" (
|
|
|
80 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
|
|
|
81 echo.
|
|
|
82 echo.Build finished; now you can run HTML Help Workshop with the ^
|
|
|
83 .hhp project file in %BUILDDIR%/htmlhelp.
|
|
|
84 goto end
|
|
|
85 )
|
|
|
86
|
|
|
87 if "%1" == "qthelp" (
|
|
|
88 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
|
|
|
89 echo.
|
|
|
90 echo.Build finished; now you can run "qcollectiongenerator" with the ^
|
|
|
91 .qhcp project file in %BUILDDIR%/qthelp, like this:
|
|
|
92 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\CoreJavaScript.qhcp
|
|
|
93 echo.To view the help file:
|
|
|
94 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\CoreJavaScript.ghc
|
|
|
95 goto end
|
|
|
96 )
|
|
|
97
|
|
|
98 if "%1" == "devhelp" (
|
|
|
99 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
|
|
|
100 echo.
|
|
|
101 echo.Build finished.
|
|
|
102 goto end
|
|
|
103 )
|
|
|
104
|
|
|
105 if "%1" == "epub" (
|
|
|
106 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
|
|
|
107 echo.
|
|
|
108 echo.Build finished. The epub file is in %BUILDDIR%/epub.
|
|
|
109 goto end
|
|
|
110 )
|
|
|
111
|
|
|
112 if "%1" == "latex" (
|
|
|
113 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
|
|
|
114 echo.
|
|
|
115 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
|
|
|
116 goto end
|
|
|
117 )
|
|
|
118
|
|
|
119 if "%1" == "text" (
|
|
|
120 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
|
|
|
121 echo.
|
|
|
122 echo.Build finished. The text files are in %BUILDDIR%/text.
|
|
|
123 goto end
|
|
|
124 )
|
|
|
125
|
|
|
126 if "%1" == "man" (
|
|
|
127 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
|
|
|
128 echo.
|
|
|
129 echo.Build finished. The manual pages are in %BUILDDIR%/man.
|
|
|
130 goto end
|
|
|
131 )
|
|
|
132
|
|
|
133 if "%1" == "gettext" (
|
|
|
134 %SPHINXBUILD% -b gettext %ALLSPHINXOPTS% %BUILDDIR%/locale
|
|
|
135 echo.
|
|
|
136 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
|
|
|
137 goto end
|
|
|
138 )
|
|
|
139
|
|
|
140 if "%1" == "changes" (
|
|
|
141 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
|
|
|
142 echo.
|
|
|
143 echo.The overview file is in %BUILDDIR%/changes.
|
|
|
144 goto end
|
|
|
145 )
|
|
|
146
|
|
|
147 if "%1" == "linkcheck" (
|
|
|
148 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
|
|
|
149 echo.
|
|
|
150 echo.Link check complete; look for any errors in the above output ^
|
|
|
151 or in %BUILDDIR%/linkcheck/output.txt.
|
|
|
152 goto end
|
|
|
153 )
|
|
|
154
|
|
|
155 if "%1" == "doctest" (
|
|
|
156 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
|
|
|
157 echo.
|
|
|
158 echo.Testing of doctests in the sources finished, look at the ^
|
|
|
159 results in %BUILDDIR%/doctest/output.txt.
|
|
|
160 goto end
|
|
|
161 )
|
|
|
162
|
|
|
163 :end
|
