make.bat 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190
  1. @ECHO OFF
  2. REM Command file for Sphinx documentation
  3. if "%SPHINXBUILD%" == "" (
  4. set SPHINXBUILD=sphinx-build
  5. )
  6. set BUILDDIR=_build
  7. set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
  8. set I18NSPHINXOPTS=%SPHINXOPTS% .
  9. if NOT "%PAPER%" == "" (
  10. set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
  11. set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
  12. )
  13. if "%1" == "" goto help
  14. if "%1" == "help" (
  15. :help
  16. echo.Please use `make ^<target^>` where ^<target^> is one of
  17. echo. html to make standalone HTML files
  18. echo. dirhtml to make HTML files named index.html in directories
  19. echo. singlehtml to make a single large HTML file
  20. echo. pickle to make pickle files
  21. echo. json to make JSON files
  22. echo. htmlhelp to make HTML files and a HTML help project
  23. echo. qthelp to make HTML files and a qthelp project
  24. echo. devhelp to make HTML files and a Devhelp project
  25. echo. epub to make an epub
  26. echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  27. echo. text to make text files
  28. echo. man to make manual pages
  29. echo. texinfo to make Texinfo files
  30. echo. gettext to make PO message catalogs
  31. echo. changes to make an overview over all changed/added/deprecated items
  32. echo. linkcheck to check all external links for integrity
  33. echo. doctest to run all doctests embedded in the documentation if enabled
  34. goto end
  35. )
  36. if "%1" == "clean" (
  37. for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
  38. del /q /s %BUILDDIR%\*
  39. goto end
  40. )
  41. if "%1" == "html" (
  42. %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
  43. if errorlevel 1 exit /b 1
  44. echo.
  45. echo.Build finished. The HTML pages are in %BUILDDIR%/html.
  46. goto end
  47. )
  48. if "%1" == "dirhtml" (
  49. %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
  50. if errorlevel 1 exit /b 1
  51. echo.
  52. echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
  53. goto end
  54. )
  55. if "%1" == "singlehtml" (
  56. %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
  57. if errorlevel 1 exit /b 1
  58. echo.
  59. echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
  60. goto end
  61. )
  62. if "%1" == "pickle" (
  63. %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
  64. if errorlevel 1 exit /b 1
  65. echo.
  66. echo.Build finished; now you can process the pickle files.
  67. goto end
  68. )
  69. if "%1" == "json" (
  70. %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
  71. if errorlevel 1 exit /b 1
  72. echo.
  73. echo.Build finished; now you can process the JSON files.
  74. goto end
  75. )
  76. if "%1" == "htmlhelp" (
  77. %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
  78. if errorlevel 1 exit /b 1
  79. echo.
  80. echo.Build finished; now you can run HTML Help Workshop with the ^
  81. .hhp project file in %BUILDDIR%/htmlhelp.
  82. goto end
  83. )
  84. if "%1" == "qthelp" (
  85. %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
  86. if errorlevel 1 exit /b 1
  87. echo.
  88. echo.Build finished; now you can run "qcollectiongenerator" with the ^
  89. .qhcp project file in %BUILDDIR%/qthelp, like this:
  90. echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Elephant.qhcp
  91. echo.To view the help file:
  92. echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Elephant.ghc
  93. goto end
  94. )
  95. if "%1" == "devhelp" (
  96. %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
  97. if errorlevel 1 exit /b 1
  98. echo.
  99. echo.Build finished.
  100. goto end
  101. )
  102. if "%1" == "epub" (
  103. %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
  104. if errorlevel 1 exit /b 1
  105. echo.
  106. echo.Build finished. The epub file is in %BUILDDIR%/epub.
  107. goto end
  108. )
  109. if "%1" == "latex" (
  110. %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
  111. if errorlevel 1 exit /b 1
  112. echo.
  113. echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
  114. goto end
  115. )
  116. if "%1" == "text" (
  117. %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
  118. if errorlevel 1 exit /b 1
  119. echo.
  120. echo.Build finished. The text files are in %BUILDDIR%/text.
  121. goto end
  122. )
  123. if "%1" == "man" (
  124. %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
  125. if errorlevel 1 exit /b 1
  126. echo.
  127. echo.Build finished. The manual pages are in %BUILDDIR%/man.
  128. goto end
  129. )
  130. if "%1" == "texinfo" (
  131. %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
  132. if errorlevel 1 exit /b 1
  133. echo.
  134. echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
  135. goto end
  136. )
  137. if "%1" == "gettext" (
  138. %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
  139. if errorlevel 1 exit /b 1
  140. echo.
  141. echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
  142. goto end
  143. )
  144. if "%1" == "changes" (
  145. %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
  146. if errorlevel 1 exit /b 1
  147. echo.
  148. echo.The overview file is in %BUILDDIR%/changes.
  149. goto end
  150. )
  151. if "%1" == "linkcheck" (
  152. %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
  153. if errorlevel 1 exit /b 1
  154. echo.
  155. echo.Link check complete; look for any errors in the above output ^
  156. or in %BUILDDIR%/linkcheck/output.txt.
  157. goto end
  158. )
  159. if "%1" == "doctest" (
  160. %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
  161. if errorlevel 1 exit /b 1
  162. echo.
  163. echo.Testing of doctests in the sources finished, look at the ^
  164. results in %BUILDDIR%/doctest/output.txt.
  165. goto end
  166. )
  167. :end