1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/mozbase/docs/make.bat Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,190 @@
1.4 +@ECHO OFF
1.5 +
1.6 +REM Command file for Sphinx documentation
1.7 +
1.8 +if "%SPHINXBUILD%" == "" (
1.9 + set SPHINXBUILD=sphinx-build
1.10 +)
1.11 +set BUILDDIR=_build
1.12 +set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
1.13 +set I18NSPHINXOPTS=%SPHINXOPTS% .
1.14 +if NOT "%PAPER%" == "" (
1.15 + set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
1.16 + set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
1.17 +)
1.18 +
1.19 +if "%1" == "" goto help
1.20 +
1.21 +if "%1" == "help" (
1.22 + :help
1.23 + echo.Please use `make ^<target^>` where ^<target^> is one of
1.24 + echo. html to make standalone HTML files
1.25 + echo. dirhtml to make HTML files named index.html in directories
1.26 + echo. singlehtml to make a single large HTML file
1.27 + echo. pickle to make pickle files
1.28 + echo. json to make JSON files
1.29 + echo. htmlhelp to make HTML files and a HTML help project
1.30 + echo. qthelp to make HTML files and a qthelp project
1.31 + echo. devhelp to make HTML files and a Devhelp project
1.32 + echo. epub to make an epub
1.33 + echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
1.34 + echo. text to make text files
1.35 + echo. man to make manual pages
1.36 + echo. texinfo to make Texinfo files
1.37 + echo. gettext to make PO message catalogs
1.38 + echo. changes to make an overview over all changed/added/deprecated items
1.39 + echo. linkcheck to check all external links for integrity
1.40 + echo. doctest to run all doctests embedded in the documentation if enabled
1.41 + goto end
1.42 +)
1.43 +
1.44 +if "%1" == "clean" (
1.45 + for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
1.46 + del /q /s %BUILDDIR%\*
1.47 + goto end
1.48 +)
1.49 +
1.50 +if "%1" == "html" (
1.51 + %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
1.52 + if errorlevel 1 exit /b 1
1.53 + echo.
1.54 + echo.Build finished. The HTML pages are in %BUILDDIR%/html.
1.55 + goto end
1.56 +)
1.57 +
1.58 +if "%1" == "dirhtml" (
1.59 + %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
1.60 + if errorlevel 1 exit /b 1
1.61 + echo.
1.62 + echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
1.63 + goto end
1.64 +)
1.65 +
1.66 +if "%1" == "singlehtml" (
1.67 + %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
1.68 + if errorlevel 1 exit /b 1
1.69 + echo.
1.70 + echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
1.71 + goto end
1.72 +)
1.73 +
1.74 +if "%1" == "pickle" (
1.75 + %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
1.76 + if errorlevel 1 exit /b 1
1.77 + echo.
1.78 + echo.Build finished; now you can process the pickle files.
1.79 + goto end
1.80 +)
1.81 +
1.82 +if "%1" == "json" (
1.83 + %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
1.84 + if errorlevel 1 exit /b 1
1.85 + echo.
1.86 + echo.Build finished; now you can process the JSON files.
1.87 + goto end
1.88 +)
1.89 +
1.90 +if "%1" == "htmlhelp" (
1.91 + %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
1.92 + if errorlevel 1 exit /b 1
1.93 + echo.
1.94 + echo.Build finished; now you can run HTML Help Workshop with the ^
1.95 +.hhp project file in %BUILDDIR%/htmlhelp.
1.96 + goto end
1.97 +)
1.98 +
1.99 +if "%1" == "qthelp" (
1.100 + %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
1.101 + if errorlevel 1 exit /b 1
1.102 + echo.
1.103 + echo.Build finished; now you can run "qcollectiongenerator" with the ^
1.104 +.qhcp project file in %BUILDDIR%/qthelp, like this:
1.105 + echo.^> qcollectiongenerator %BUILDDIR%\qthelp\MozBase.qhcp
1.106 + echo.To view the help file:
1.107 + echo.^> assistant -collectionFile %BUILDDIR%\qthelp\MozBase.ghc
1.108 + goto end
1.109 +)
1.110 +
1.111 +if "%1" == "devhelp" (
1.112 + %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
1.113 + if errorlevel 1 exit /b 1
1.114 + echo.
1.115 + echo.Build finished.
1.116 + goto end
1.117 +)
1.118 +
1.119 +if "%1" == "epub" (
1.120 + %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
1.121 + if errorlevel 1 exit /b 1
1.122 + echo.
1.123 + echo.Build finished. The epub file is in %BUILDDIR%/epub.
1.124 + goto end
1.125 +)
1.126 +
1.127 +if "%1" == "latex" (
1.128 + %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
1.129 + if errorlevel 1 exit /b 1
1.130 + echo.
1.131 + echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
1.132 + goto end
1.133 +)
1.134 +
1.135 +if "%1" == "text" (
1.136 + %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
1.137 + if errorlevel 1 exit /b 1
1.138 + echo.
1.139 + echo.Build finished. The text files are in %BUILDDIR%/text.
1.140 + goto end
1.141 +)
1.142 +
1.143 +if "%1" == "man" (
1.144 + %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
1.145 + if errorlevel 1 exit /b 1
1.146 + echo.
1.147 + echo.Build finished. The manual pages are in %BUILDDIR%/man.
1.148 + goto end
1.149 +)
1.150 +
1.151 +if "%1" == "texinfo" (
1.152 + %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
1.153 + if errorlevel 1 exit /b 1
1.154 + echo.
1.155 + echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
1.156 + goto end
1.157 +)
1.158 +
1.159 +if "%1" == "gettext" (
1.160 + %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
1.161 + if errorlevel 1 exit /b 1
1.162 + echo.
1.163 + echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
1.164 + goto end
1.165 +)
1.166 +
1.167 +if "%1" == "changes" (
1.168 + %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
1.169 + if errorlevel 1 exit /b 1
1.170 + echo.
1.171 + echo.The overview file is in %BUILDDIR%/changes.
1.172 + goto end
1.173 +)
1.174 +
1.175 +if "%1" == "linkcheck" (
1.176 + %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
1.177 + if errorlevel 1 exit /b 1
1.178 + echo.
1.179 + echo.Link check complete; look for any errors in the above output ^
1.180 +or in %BUILDDIR%/linkcheck/output.txt.
1.181 + goto end
1.182 +)
1.183 +
1.184 +if "%1" == "doctest" (
1.185 + %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
1.186 + if errorlevel 1 exit /b 1
1.187 + echo.
1.188 + echo.Testing of doctests in the sources finished, look at the ^
1.189 +results in %BUILDDIR%/doctest/output.txt.
1.190 + goto end
1.191 +)
1.192 +
1.193 +:end
