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