make.bat 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. @ECHO OFF
  2. REM Command file for Sphinx documentation
  3. set SPHINXBUILD=sphinx-build
  4. set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% .
  5. if NOT "%PAPER%" == "" (
  6. set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
  7. )
  8. if "%1" == "" goto help
  9. if "%1" == "help" (
  10. :help
  11. echo.Please use `make ^<target^>` where ^<target^> is one of
  12. echo. html to make standalone HTML files
  13. echo. dirhtml to make HTML files named index.html in directories
  14. echo. pickle to make pickle files
  15. echo. json to make JSON files
  16. echo. htmlhelp to make HTML files and a HTML help project
  17. echo. qthelp to make HTML files and a qthelp project
  18. echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  19. echo. changes to make an overview over all changed/added/deprecated items
  20. echo. linkcheck to check all external links for integrity
  21. echo. doctest to run all doctests embedded in the documentation if enabled
  22. goto end
  23. )
  24. if "%1" == "clean" (
  25. for /d %%i in (_build\*) do rmdir /q /s %%i
  26. del /q /s _build\*
  27. goto end
  28. )
  29. if "%1" == "html" (
  30. %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
  31. echo.
  32. echo.Build finished. The HTML pages are in _build/html.
  33. goto end
  34. )
  35. if "%1" == "dirhtml" (
  36. %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml
  37. echo.
  38. echo.Build finished. The HTML pages are in _build/dirhtml.
  39. goto end
  40. )
  41. if "%1" == "pickle" (
  42. %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
  43. echo.
  44. echo.Build finished; now you can process the pickle files.
  45. goto end
  46. )
  47. if "%1" == "json" (
  48. %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
  49. echo.
  50. echo.Build finished; now you can process the JSON files.
  51. goto end
  52. )
  53. if "%1" == "htmlhelp" (
  54. %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
  55. echo.
  56. echo.Build finished; now you can run HTML Help Workshop with the ^
  57. .hhp project file in _build/htmlhelp.
  58. goto end
  59. )
  60. if "%1" == "qthelp" (
  61. %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
  62. echo.
  63. echo.Build finished; now you can run "qcollectiongenerator" with the ^
  64. .qhcp project file in _build/qthelp, like this:
  65. echo.^> qcollectiongenerator _build\qthelp\futures.qhcp
  66. echo.To view the help file:
  67. echo.^> assistant -collectionFile _build\qthelp\futures.ghc
  68. goto end
  69. )
  70. if "%1" == "latex" (
  71. %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex
  72. echo.
  73. echo.Build finished; the LaTeX files are in _build/latex.
  74. goto end
  75. )
  76. if "%1" == "changes" (
  77. %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
  78. echo.
  79. echo.The overview file is in _build/changes.
  80. goto end
  81. )
  82. if "%1" == "linkcheck" (
  83. %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
  84. echo.
  85. echo.Link check complete; look for any errors in the above output ^
  86. or in _build/linkcheck/output.txt.
  87. goto end
  88. )
  89. if "%1" == "doctest" (
  90. %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
  91. echo.
  92. echo.Testing of doctests in the sources finished, look at the ^
  93. results in _build/doctest/output.txt.
  94. goto end
  95. )
  96. :end