3 REM Command file for Sphinx documentation
5 if "%SPHINXBUILD%" == "" (
6 set SPHINXBUILD=sphinx-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%
16 if "%1" == "" goto 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
42 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43 del /q /s %BUILDDIR%\*
48 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49 if errorlevel 1 exit /b 1
51 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
55 if "%1" == "dirhtml" (
56 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57 if errorlevel 1 exit /b 1
59 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
63 if "%1" == "singlehtml" (
64 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65 if errorlevel 1 exit /b 1
67 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
72 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73 if errorlevel 1 exit /b 1
75 echo.Build finished; now you can process the pickle files.
80 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81 if errorlevel 1 exit /b 1
83 echo.Build finished; now you can process the JSON files.
87 if "%1" == "htmlhelp" (
88 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89 if errorlevel 1 exit /b 1
91 echo.Build finished; now you can run HTML Help Workshop with the ^
92 .hhp project file in %BUILDDIR%/htmlhelp.
97 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98 if errorlevel 1 exit /b 1
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\llvm.qhcp
103 echo.To view the help file:
104 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\llvm.ghc
108 if "%1" == "devhelp" (
109 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110 if errorlevel 1 exit /b 1
117 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118 if errorlevel 1 exit /b 1
120 echo.Build finished. The epub file is in %BUILDDIR%/epub.
125 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126 if errorlevel 1 exit /b 1
128 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
133 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134 if errorlevel 1 exit /b 1
136 echo.Build finished. The text files are in %BUILDDIR%/text.
141 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142 if errorlevel 1 exit /b 1
144 echo.Build finished. The manual pages are in %BUILDDIR%/man.
148 if "%1" == "texinfo" (
149 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150 if errorlevel 1 exit /b 1
152 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
156 if "%1" == "gettext" (
157 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158 if errorlevel 1 exit /b 1
160 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
164 if "%1" == "changes" (
165 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166 if errorlevel 1 exit /b 1
168 echo.The overview file is in %BUILDDIR%/changes.
172 if "%1" == "linkcheck" (
173 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174 if errorlevel 1 exit /b 1
176 echo.Link check complete; look for any errors in the above output ^
177 or in %BUILDDIR%/linkcheck/output.txt.
181 if "%1" == "doctest" (
182 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183 if errorlevel 1 exit /b 1
185 echo.Testing of doctests in the sources finished, look at the ^
186 results in %BUILDDIR%/doctest/output.txt.