175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar@ECHO OFF 275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel DunbarREM Command file for Sphinx documentation 475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%SPHINXBUILD%" == "" ( 675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar set SPHINXBUILD=sphinx-build 775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarset BUILDDIR=_build 975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . 1075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarset I18NSPHINXOPTS=%SPHINXOPTS% . 1175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif NOT "%PAPER%" == "" ( 1275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 1375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 1475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 1575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 1675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "" goto help 1775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 1875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "help" ( 1975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar :help 2075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Please use `make ^<target^>` where ^<target^> is one of 2175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. html to make standalone HTML files 2275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. dirhtml to make HTML files named index.html in directories 2375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. singlehtml to make a single large HTML file 2475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. pickle to make pickle files 2575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. json to make JSON files 2675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. htmlhelp to make HTML files and a HTML help project 2775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. qthelp to make HTML files and a qthelp project 2875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. devhelp to make HTML files and a Devhelp project 2975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. epub to make an epub 3075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 3175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. text to make text files 3275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. man to make manual pages 3375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. texinfo to make Texinfo files 3475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. gettext to make PO message catalogs 3575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. changes to make an overview over all changed/added/deprecated items 3675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. linkcheck to check all external links for integrity 3775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. doctest to run all doctests embedded in the documentation if enabled 3875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 3975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 4075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 4175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "clean" ( 4275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 4375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar del /q /s %BUILDDIR%\* 4475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 4575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 4675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 4775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "html" ( 4875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 4975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 5075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 5175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The HTML pages are in %BUILDDIR%/html. 5275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 5375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 5475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 5575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "dirhtml" ( 5675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 5775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 5875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 5975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 6075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 6175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 6275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 6375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "singlehtml" ( 6475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 6575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 6675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 6775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 6875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 6975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 7075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 7175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "pickle" ( 7275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 7375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 7475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 7575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished; now you can process the pickle files. 7675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 7775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 7875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 7975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "json" ( 8075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 8175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 8275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 8375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished; now you can process the JSON files. 8475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 8575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 8675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 8775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "htmlhelp" ( 8875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 8975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 9075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 9175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished; now you can run HTML Help Workshop with the ^ 9275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar.hhp project file in %BUILDDIR%/htmlhelp. 9375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 9475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 9575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 9675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "qthelp" ( 9775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 9875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 9975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 10075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished; now you can run "qcollectiongenerator" with the ^ 10175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar.qhcp project file in %BUILDDIR%/qthelp, like this: 10275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.^> qcollectiongenerator %BUILDDIR%\qthelp\llvm.qhcp 10375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.To view the help file: 10475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.^> assistant -collectionFile %BUILDDIR%\qthelp\llvm.ghc 10575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 10675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 10775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 10875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "devhelp" ( 10975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 11075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 11175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 11275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. 11375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 11475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 11575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 11675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "epub" ( 11775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 11875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 11975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 12075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The epub file is in %BUILDDIR%/epub. 12175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 12275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 12375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 12475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "latex" ( 12575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 12675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 12775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 12875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 12975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 13075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 13175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 13275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "text" ( 13375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 13475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 13575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 13675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The text files are in %BUILDDIR%/text. 13775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 13875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 13975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 14075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "man" ( 14175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 14275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 14375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 14475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The manual pages are in %BUILDDIR%/man. 14575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 14675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 14775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 14875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "texinfo" ( 14975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 15075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 15175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 15275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 15375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 15475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 15575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 15675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "gettext" ( 15775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 15875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 15975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 16075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 16175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 16275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 16375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 16475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "changes" ( 16575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 16675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 16775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 16875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.The overview file is in %BUILDDIR%/changes. 16975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 17075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 17175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 17275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "linkcheck" ( 17375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 17475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 17575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 17675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Link check complete; look for any errors in the above output ^ 17775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbaror in %BUILDDIR%/linkcheck/output.txt. 17875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 17975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 18075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 18175083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarif "%1" == "doctest" ( 18275083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 18375083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar if errorlevel 1 exit /b 1 18475083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo. 18575083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar echo.Testing of doctests in the sources finished, look at the ^ 18675083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbarresults in %BUILDDIR%/doctest/output.txt. 18775083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar goto end 18875083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar) 18975083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar 19075083ebc09a3dd47099e3912ac090dbc907f3eafDaniel Dunbar:end 191