191 lines · plain
1@ECHO OFF2 3REM Command file for Sphinx documentation4 5if "%SPHINXBUILD%" == "" (6 set SPHINXBUILD=sphinx-build7)8set BUILDDIR=_build9set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .10set I18NSPHINXOPTS=%SPHINXOPTS% .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 help17 18if "%1" == "help" (19 :help20 echo.Please use `make ^<target^>` where ^<target^> is one of21 echo. html to make standalone HTML files22 echo. dirhtml to make HTML files named index.html in directories23 echo. singlehtml to make a single large HTML file24 echo. pickle to make pickle files25 echo. json to make JSON files26 echo. htmlhelp to make HTML files and a HTML help project27 echo. qthelp to make HTML files and a qthelp project28 echo. devhelp to make HTML files and a Devhelp project29 echo. epub to make an epub30 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter31 echo. text to make text files32 echo. man to make manual pages33 echo. texinfo to make Texinfo files34 echo. gettext to make PO message catalogs35 echo. changes to make an overview over all changed/added/deprecated items36 echo. linkcheck to check all external links for integrity37 echo. doctest to run all doctests embedded in the documentation if enabled38 goto end39)40 41if "%1" == "clean" (42 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i43 del /q /s %BUILDDIR%\*44 goto end45)46 47if "%1" == "html" (48 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html49 if errorlevel 1 exit /b 150 echo.51 echo.Build finished. The HTML pages are in %BUILDDIR%/html.52 goto end53)54 55if "%1" == "dirhtml" (56 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml57 if errorlevel 1 exit /b 158 echo.59 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.60 goto end61)62 63if "%1" == "singlehtml" (64 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml65 if errorlevel 1 exit /b 166 echo.67 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.68 goto end69)70 71if "%1" == "pickle" (72 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle73 if errorlevel 1 exit /b 174 echo.75 echo.Build finished; now you can process the pickle files.76 goto end77)78 79if "%1" == "json" (80 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json81 if errorlevel 1 exit /b 182 echo.83 echo.Build finished; now you can process the JSON files.84 goto end85)86 87if "%1" == "htmlhelp" (88 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp89 if errorlevel 1 exit /b 190 echo.91 echo.Build finished; now you can run HTML Help Workshop with the ^92.hhp project file in %BUILDDIR%/htmlhelp.93 goto end94)95 96if "%1" == "qthelp" (97 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp98 if errorlevel 1 exit /b 199 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\lld.qhcp103 echo.To view the help file:104 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\lld.ghc105 goto end106)107 108if "%1" == "devhelp" (109 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp110 if errorlevel 1 exit /b 1111 echo.112 echo.Build finished.113 goto end114)115 116if "%1" == "epub" (117 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub118 if errorlevel 1 exit /b 1119 echo.120 echo.Build finished. The epub file is in %BUILDDIR%/epub.121 goto end122)123 124if "%1" == "latex" (125 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex126 if errorlevel 1 exit /b 1127 echo.128 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.129 goto end130)131 132if "%1" == "text" (133 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text134 if errorlevel 1 exit /b 1135 echo.136 echo.Build finished. The text files are in %BUILDDIR%/text.137 goto end138)139 140if "%1" == "man" (141 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man142 if errorlevel 1 exit /b 1143 echo.144 echo.Build finished. The manual pages are in %BUILDDIR%/man.145 goto end146)147 148if "%1" == "texinfo" (149 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo150 if errorlevel 1 exit /b 1151 echo.152 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.153 goto end154)155 156if "%1" == "gettext" (157 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale158 if errorlevel 1 exit /b 1159 echo.160 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.161 goto end162)163 164if "%1" == "changes" (165 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes166 if errorlevel 1 exit /b 1167 echo.168 echo.The overview file is in %BUILDDIR%/changes.169 goto end170)171 172if "%1" == "linkcheck" (173 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck174 if errorlevel 1 exit /b 1175 echo.176 echo.Link check complete; look for any errors in the above output ^177or in %BUILDDIR%/linkcheck/output.txt.178 goto end179)180 181if "%1" == "doctest" (182 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest183 if errorlevel 1 exit /b 1184 echo.185 echo.Testing of doctests in the sources finished, look at the ^186results in %BUILDDIR%/doctest/output.txt.187 goto end188)189 190:end191