source: softGlue_examples/make.bat @ 951

Last change on this file since 951 was 923, checked in by jemian, 11 years ago

tweaked the instructions for publishing from the SVN server

  • Property svn:eol-style set to native
File size: 5.1 KB
Line 
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% source
10set I18NSPHINXOPTS=%SPHINXOPTS% source
11if NOT "%PAPER%" == "" (
12        set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13        set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14)
15
16if "%1" == "" goto help
17
18if "%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
41if "%1" == "clean" (
42        REM for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43        REM del /q /s %BUILDDIR%\*
44        rmdir /q /s %BUILDDIR%\doctrees
45        del /q /s %BUILDDIR%\doctrees
46        goto end
47)
48
49if "%1" == "html" (
50        %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
51        if errorlevel 1 exit /b 1
52        echo.
53        echo.Build finished. The HTML pages are in %BUILDDIR%/html.
54        goto end
55)
56
57if "%1" == "dirhtml" (
58        %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
59        if errorlevel 1 exit /b 1
60        echo.
61        echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
62        goto end
63)
64
65if "%1" == "singlehtml" (
66        %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
67        if errorlevel 1 exit /b 1
68        echo.
69        echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
70        goto end
71)
72
73if "%1" == "pickle" (
74        %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
75        if errorlevel 1 exit /b 1
76        echo.
77        echo.Build finished; now you can process the pickle files.
78        goto end
79)
80
81if "%1" == "json" (
82        %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
83        if errorlevel 1 exit /b 1
84        echo.
85        echo.Build finished; now you can process the JSON files.
86        goto end
87)
88
89if "%1" == "htmlhelp" (
90        %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
91        if errorlevel 1 exit /b 1
92        echo.
93        echo.Build finished; now you can run HTML Help Workshop with the ^
94.hhp project file in %BUILDDIR%/htmlhelp.
95        goto end
96)
97
98if "%1" == "qthelp" (
99        %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
100        if errorlevel 1 exit /b 1
101        echo.
102        echo.Build finished; now you can run "qcollectiongenerator" with the ^
103.qhcp project file in %BUILDDIR%/qthelp, like this:
104        echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pulse_train.qhcp
105        echo.To view the help file:
106        echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pulse_train.ghc
107        goto end
108)
109
110if "%1" == "devhelp" (
111        %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
112        if errorlevel 1 exit /b 1
113        echo.
114        echo.Build finished.
115        goto end
116)
117
118if "%1" == "epub" (
119        %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
120        if errorlevel 1 exit /b 1
121        echo.
122        echo.Build finished. The epub file is in %BUILDDIR%/epub.
123        goto end
124)
125
126if "%1" == "latex" (
127        %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
128        if errorlevel 1 exit /b 1
129        echo.
130        echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
131        goto end
132)
133
134if "%1" == "text" (
135        %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
136        if errorlevel 1 exit /b 1
137        echo.
138        echo.Build finished. The text files are in %BUILDDIR%/text.
139        goto end
140)
141
142if "%1" == "man" (
143        %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
144        if errorlevel 1 exit /b 1
145        echo.
146        echo.Build finished. The manual pages are in %BUILDDIR%/man.
147        goto end
148)
149
150if "%1" == "texinfo" (
151        %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
152        if errorlevel 1 exit /b 1
153        echo.
154        echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
155        goto end
156)
157
158if "%1" == "gettext" (
159        %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
160        if errorlevel 1 exit /b 1
161        echo.
162        echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
163        goto end
164)
165
166if "%1" == "changes" (
167        %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
168        if errorlevel 1 exit /b 1
169        echo.
170        echo.The overview file is in %BUILDDIR%/changes.
171        goto end
172)
173
174if "%1" == "linkcheck" (
175        %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
176        if errorlevel 1 exit /b 1
177        echo.
178        echo.Link check complete; look for any errors in the above output ^
179or in %BUILDDIR%/linkcheck/output.txt.
180        goto end
181)
182
183if "%1" == "doctest" (
184        %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
185        if errorlevel 1 exit /b 1
186        echo.
187        echo.Testing of doctests in the sources finished, look at the ^
188results in %BUILDDIR%/doctest/output.txt.
189        goto end
190)
191
192:end
Note: See TracBrowser for help on using the repository browser.