Skip to content

HTTPS clone URL

Subversion checkout URL

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