make.bat 3.0 KB

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