make.bat revision 280461
1280461Sdim@ECHO OFF 2280461Sdim 3280461SdimREM Command file for Sphinx documentation 4280461Sdim 5280461Sdimif "%SPHINXBUILD%" == "" ( 6280461Sdim set SPHINXBUILD=sphinx-build 7280461Sdim) 8280461Sdimset BUILDDIR=_build 9280461Sdimset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . 10280461Sdimset I18NSPHINXOPTS=%SPHINXOPTS% . 11280461Sdimif NOT "%PAPER%" == "" ( 12280461Sdim set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 13280461Sdim set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 14280461Sdim) 15280461Sdim 16280461Sdimif "%1" == "" goto help 17280461Sdim 18280461Sdimif "%1" == "help" ( 19280461Sdim :help 20280461Sdim echo.Please use `make ^<target^>` where ^<target^> is one of 21280461Sdim echo. html to make standalone HTML files 22280461Sdim echo. dirhtml to make HTML files named index.html in directories 23280461Sdim echo. singlehtml to make a single large HTML file 24280461Sdim echo. pickle to make pickle files 25280461Sdim echo. json to make JSON files 26280461Sdim echo. htmlhelp to make HTML files and a HTML help project 27280461Sdim echo. qthelp to make HTML files and a qthelp project 28280461Sdim echo. devhelp to make HTML files and a Devhelp project 29280461Sdim echo. epub to make an epub 30280461Sdim echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 31280461Sdim echo. text to make text files 32280461Sdim echo. man to make manual pages 33280461Sdim echo. texinfo to make Texinfo files 34280461Sdim echo. gettext to make PO message catalogs 35280461Sdim echo. changes to make an overview over all changed/added/deprecated items 36280461Sdim echo. linkcheck to check all external links for integrity 37280461Sdim echo. doctest to run all doctests embedded in the documentation if enabled 38280461Sdim goto end 39280461Sdim) 40280461Sdim 41280461Sdimif "%1" == "clean" ( 42280461Sdim for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 43280461Sdim del /q /s %BUILDDIR%\* 44280461Sdim goto end 45280461Sdim) 46280461Sdim 47280461Sdimif "%1" == "html" ( 48280461Sdim %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 49280461Sdim if errorlevel 1 exit /b 1 50280461Sdim echo. 51280461Sdim echo.Build finished. The HTML pages are in %BUILDDIR%/html. 52280461Sdim goto end 53280461Sdim) 54280461Sdim 55280461Sdimif "%1" == "dirhtml" ( 56280461Sdim %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 57280461Sdim if errorlevel 1 exit /b 1 58280461Sdim echo. 59280461Sdim echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 60280461Sdim goto end 61280461Sdim) 62280461Sdim 63280461Sdimif "%1" == "singlehtml" ( 64280461Sdim %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 65280461Sdim if errorlevel 1 exit /b 1 66280461Sdim echo. 67280461Sdim echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 68280461Sdim goto end 69280461Sdim) 70280461Sdim 71280461Sdimif "%1" == "pickle" ( 72280461Sdim %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 73280461Sdim if errorlevel 1 exit /b 1 74280461Sdim echo. 75280461Sdim echo.Build finished; now you can process the pickle files. 76280461Sdim goto end 77280461Sdim) 78280461Sdim 79280461Sdimif "%1" == "json" ( 80280461Sdim %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 81280461Sdim if errorlevel 1 exit /b 1 82280461Sdim echo. 83280461Sdim echo.Build finished; now you can process the JSON files. 84280461Sdim goto end 85280461Sdim) 86280461Sdim 87280461Sdimif "%1" == "htmlhelp" ( 88280461Sdim %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 89280461Sdim if errorlevel 1 exit /b 1 90280461Sdim echo. 91280461Sdim echo.Build finished; now you can run HTML Help Workshop with the ^ 92280461Sdim.hhp project file in %BUILDDIR%/htmlhelp. 93280461Sdim goto end 94280461Sdim) 95280461Sdim 96280461Sdimif "%1" == "qthelp" ( 97280461Sdim %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 98280461Sdim if errorlevel 1 exit /b 1 99280461Sdim echo. 100280461Sdim echo.Build finished; now you can run "qcollectiongenerator" with the ^ 101280461Sdim.qhcp project file in %BUILDDIR%/qthelp, like this: 102280461Sdim echo.^> qcollectiongenerator %BUILDDIR%\qthelp\lld.qhcp 103280461Sdim echo.To view the help file: 104280461Sdim echo.^> assistant -collectionFile %BUILDDIR%\qthelp\lld.ghc 105280461Sdim goto end 106280461Sdim) 107280461Sdim 108280461Sdimif "%1" == "devhelp" ( 109280461Sdim %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 110280461Sdim if errorlevel 1 exit /b 1 111280461Sdim echo. 112280461Sdim echo.Build finished. 113280461Sdim goto end 114280461Sdim) 115280461Sdim 116280461Sdimif "%1" == "epub" ( 117280461Sdim %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 118280461Sdim if errorlevel 1 exit /b 1 119280461Sdim echo. 120280461Sdim echo.Build finished. The epub file is in %BUILDDIR%/epub. 121280461Sdim goto end 122280461Sdim) 123280461Sdim 124280461Sdimif "%1" == "latex" ( 125280461Sdim %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 126280461Sdim if errorlevel 1 exit /b 1 127280461Sdim echo. 128280461Sdim echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 129280461Sdim goto end 130280461Sdim) 131280461Sdim 132280461Sdimif "%1" == "text" ( 133280461Sdim %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 134280461Sdim if errorlevel 1 exit /b 1 135280461Sdim echo. 136280461Sdim echo.Build finished. The text files are in %BUILDDIR%/text. 137280461Sdim goto end 138280461Sdim) 139280461Sdim 140280461Sdimif "%1" == "man" ( 141280461Sdim %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 142280461Sdim if errorlevel 1 exit /b 1 143280461Sdim echo. 144280461Sdim echo.Build finished. The manual pages are in %BUILDDIR%/man. 145280461Sdim goto end 146280461Sdim) 147280461Sdim 148280461Sdimif "%1" == "texinfo" ( 149280461Sdim %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 150280461Sdim if errorlevel 1 exit /b 1 151280461Sdim echo. 152280461Sdim echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 153280461Sdim goto end 154280461Sdim) 155280461Sdim 156280461Sdimif "%1" == "gettext" ( 157280461Sdim %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 158280461Sdim if errorlevel 1 exit /b 1 159280461Sdim echo. 160280461Sdim echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 161280461Sdim goto end 162280461Sdim) 163280461Sdim 164280461Sdimif "%1" == "changes" ( 165280461Sdim %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 166280461Sdim if errorlevel 1 exit /b 1 167280461Sdim echo. 168280461Sdim echo.The overview file is in %BUILDDIR%/changes. 169280461Sdim goto end 170280461Sdim) 171280461Sdim 172280461Sdimif "%1" == "linkcheck" ( 173280461Sdim %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 174280461Sdim if errorlevel 1 exit /b 1 175280461Sdim echo. 176280461Sdim echo.Link check complete; look for any errors in the above output ^ 177280461Sdimor in %BUILDDIR%/linkcheck/output.txt. 178280461Sdim goto end 179280461Sdim) 180280461Sdim 181280461Sdimif "%1" == "doctest" ( 182280461Sdim %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 183280461Sdim if errorlevel 1 exit /b 1 184280461Sdim echo. 185280461Sdim echo.Testing of doctests in the sources finished, look at the ^ 186280461Sdimresults in %BUILDDIR%/doctest/output.txt. 187280461Sdim goto end 188280461Sdim) 189280461Sdim 190280461Sdim:end 191