0001 @ECHO OFF
0002
0003 REM Command file for Sphinx documentation
0004
0005 set PYTHONPATH=..;..\lib\py4j-0.10.9-src.zip
0006
0007
0008 if "%SPHINXBUILD%" == "" (
0009 set SPHINXBUILD=sphinx-build
0010 )
0011 set BUILDDIR=_build
0012 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
0013 set I18NSPHINXOPTS=%SPHINXOPTS% .
0014 if NOT "%PAPER%" == "" (
0015 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
0016 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
0017 )
0018
0019 if "%1" == "" goto help
0020
0021 if "%1" == "help" (
0022 :help
0023 echo.Please use `make ^<target^>` where ^<target^> is one of
0024 echo. html to make standalone HTML files
0025 echo. dirhtml to make HTML files named index.html in directories
0026 echo. singlehtml to make a single large HTML file
0027 echo. pickle to make pickle files
0028 echo. json to make JSON files
0029 echo. htmlhelp to make HTML files and a HTML help project
0030 echo. qthelp to make HTML files and a qthelp project
0031 echo. devhelp to make HTML files and a Devhelp project
0032 echo. epub to make an epub
0033 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
0034 echo. text to make text files
0035 echo. man to make manual pages
0036 echo. texinfo to make Texinfo files
0037 echo. gettext to make PO message catalogs
0038 echo. changes to make an overview over all changed/added/deprecated items
0039 echo. xml to make Docutils-native XML files
0040 echo. pseudoxml to make pseudoxml-XML files for display purposes
0041 echo. linkcheck to check all external links for integrity
0042 echo. doctest to run all doctests embedded in the documentation if enabled
0043 goto end
0044 )
0045
0046 if "%1" == "clean" (
0047 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
0048 del /q /s %BUILDDIR%\*
0049 goto end
0050 )
0051
0052
0053 %SPHINXBUILD% 2> nul
0054 if errorlevel 9009 (
0055 echo.
0056 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
0057 echo.installed, then set the SPHINXBUILD environment variable to point
0058 echo.to the full path of the 'sphinx-build' executable. Alternatively you
0059 echo.may add the Sphinx directory to PATH.
0060 echo.
0061 echo.If you don't have Sphinx installed, grab it from
0062 echo.http://sphinx-doc.org/
0063 exit /b 1
0064 )
0065
0066 if "%1" == "html" (
0067 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
0068 if errorlevel 1 exit /b 1
0069 echo.
0070 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
0071 goto end
0072 )
0073
0074 if "%1" == "dirhtml" (
0075 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
0076 if errorlevel 1 exit /b 1
0077 echo.
0078 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
0079 goto end
0080 )
0081
0082 if "%1" == "singlehtml" (
0083 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
0084 if errorlevel 1 exit /b 1
0085 echo.
0086 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
0087 goto end
0088 )
0089
0090 if "%1" == "pickle" (
0091 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
0092 if errorlevel 1 exit /b 1
0093 echo.
0094 echo.Build finished; now you can process the pickle files.
0095 goto end
0096 )
0097
0098 if "%1" == "json" (
0099 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
0100 if errorlevel 1 exit /b 1
0101 echo.
0102 echo.Build finished; now you can process the JSON files.
0103 goto end
0104 )
0105
0106 if "%1" == "htmlhelp" (
0107 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
0108 if errorlevel 1 exit /b 1
0109 echo.
0110 echo.Build finished; now you can run HTML Help Workshop with the ^
0111 .hhp project file in %BUILDDIR%/htmlhelp.
0112 goto end
0113 )
0114
0115 if "%1" == "qthelp" (
0116 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
0117 if errorlevel 1 exit /b 1
0118 echo.
0119 echo.Build finished; now you can run "qcollectiongenerator" with the ^
0120 .qhcp project file in %BUILDDIR%/qthelp, like this:
0121 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\pyspark.qhcp
0122 echo.To view the help file:
0123 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\pyspark.ghc
0124 goto end
0125 )
0126
0127 if "%1" == "devhelp" (
0128 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
0129 if errorlevel 1 exit /b 1
0130 echo.
0131 echo.Build finished.
0132 goto end
0133 )
0134
0135 if "%1" == "epub" (
0136 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
0137 if errorlevel 1 exit /b 1
0138 echo.
0139 echo.Build finished. The epub file is in %BUILDDIR%/epub.
0140 goto end
0141 )
0142
0143 if "%1" == "latex" (
0144 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
0145 if errorlevel 1 exit /b 1
0146 echo.
0147 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
0148 goto end
0149 )
0150
0151 if "%1" == "latexpdf" (
0152 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
0153 cd %BUILDDIR%/latex
0154 make all-pdf
0155 cd %BUILDDIR%/..
0156 echo.
0157 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
0158 goto end
0159 )
0160
0161 if "%1" == "latexpdfja" (
0162 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
0163 cd %BUILDDIR%/latex
0164 make all-pdf-ja
0165 cd %BUILDDIR%/..
0166 echo.
0167 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
0168 goto end
0169 )
0170
0171 if "%1" == "text" (
0172 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
0173 if errorlevel 1 exit /b 1
0174 echo.
0175 echo.Build finished. The text files are in %BUILDDIR%/text.
0176 goto end
0177 )
0178
0179 if "%1" == "man" (
0180 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
0181 if errorlevel 1 exit /b 1
0182 echo.
0183 echo.Build finished. The manual pages are in %BUILDDIR%/man.
0184 goto end
0185 )
0186
0187 if "%1" == "texinfo" (
0188 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
0189 if errorlevel 1 exit /b 1
0190 echo.
0191 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
0192 goto end
0193 )
0194
0195 if "%1" == "gettext" (
0196 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
0197 if errorlevel 1 exit /b 1
0198 echo.
0199 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
0200 goto end
0201 )
0202
0203 if "%1" == "changes" (
0204 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
0205 if errorlevel 1 exit /b 1
0206 echo.
0207 echo.The overview file is in %BUILDDIR%/changes.
0208 goto end
0209 )
0210
0211 if "%1" == "linkcheck" (
0212 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
0213 if errorlevel 1 exit /b 1
0214 echo.
0215 echo.Link check complete; look for any errors in the above output ^
0216 or in %BUILDDIR%/linkcheck/output.txt.
0217 goto end
0218 )
0219
0220 if "%1" == "doctest" (
0221 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
0222 if errorlevel 1 exit /b 1
0223 echo.
0224 echo.Testing of doctests in the sources finished, look at the ^
0225 results in %BUILDDIR%/doctest/output.txt.
0226 goto end
0227 )
0228
0229 if "%1" == "xml" (
0230 %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
0231 if errorlevel 1 exit /b 1
0232 echo.
0233 echo.Build finished. The XML files are in %BUILDDIR%/xml.
0234 goto end
0235 )
0236
0237 if "%1" == "pseudoxml" (
0238 %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
0239 if errorlevel 1 exit /b 1
0240 echo.
0241 echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
0242 goto end
0243 )
0244
0245 :end
