3 REM Command file for Sphinx documentation
5 if "%SPHINXBUILD%" == "" (
6 set SPHINXBUILD=sphinx-build
9 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10 set I18NSPHINXOPTS=%SPHINXOPTS% .
11 if NOT "%PAPER%" == "" (
12 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
16 if "%1" == "" goto help
20 echo.Please use `make ^<target^>` where ^<target^> is one of
21 echo. html to make standalone HTML files
22 echo. dirhtml to make HTML files named index.html in directories
23 echo. singlehtml to make a single large HTML file
24 echo. pickle to make pickle files
25 echo. json to make JSON files
26 echo. htmlhelp to make HTML files and a HTML help project
27 echo. qthelp to make HTML files and a qthelp project
28 echo. devhelp to make HTML files and a Devhelp project
29 echo. epub to make an epub
30 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31 echo. text to make text files
32 echo. man to make manual pages
33 echo. texinfo to make Texinfo files
34 echo. gettext to make PO message catalogs
35 echo. changes to make an overview over all changed/added/deprecated items
36 echo. xml to make Docutils-native XML files
37 echo. pseudoxml to make pseudoxml-XML files for display purposes
38 echo. linkcheck to check all external links for integrity
39 echo. doctest to run all doctests embedded in the documentation if enabled
44 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
45 del /q /s %BUILDDIR%\*
53 echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
54 echo.installed, then set the SPHINXBUILD environment variable to point
55 echo.to the full path of the 'sphinx-build' executable. Alternatively you
56 echo.may add the Sphinx directory to PATH.
58 echo.If you don't have Sphinx installed, grab it from
59 echo.http://sphinx-doc.org/
64 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
65 if errorlevel 1 exit /b 1
67 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
71 if "%1" == "dirhtml" (
72 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
73 if errorlevel 1 exit /b 1
75 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
79 if "%1" == "singlehtml" (
80 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
81 if errorlevel 1 exit /b 1
83 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
88 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
89 if errorlevel 1 exit /b 1
91 echo.Build finished; now you can process the pickle files.
96 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
97 if errorlevel 1 exit /b 1
99 echo.Build finished; now you can process the JSON files.
103 if "%1" == "htmlhelp" (
104 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
105 if errorlevel 1 exit /b 1
107 echo.Build finished; now you can run HTML Help Workshop with the ^
108 .hhp project file in %BUILDDIR%/htmlhelp.
112 if "%1" == "qthelp" (
113 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
114 if errorlevel 1 exit /b 1
116 echo.Build finished; now you can run "qcollectiongenerator" with the ^
117 .qhcp project file in %BUILDDIR%/qthelp, like this:
118 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\phpMyAdmin.qhcp
119 echo.To view the help file:
120 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\phpMyAdmin.ghc
124 if "%1" == "devhelp" (
125 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
126 if errorlevel 1 exit /b 1
133 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
134 if errorlevel 1 exit /b 1
136 echo.Build finished. The epub file is in %BUILDDIR%/epub.
141 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
142 if errorlevel 1 exit /b 1
144 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
148 if "%1" == "latexpdf" (
149 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
154 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
158 if "%1" == "latexpdfja" (
159 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
164 echo.Build finished; the PDF files are in %BUILDDIR%/latex.
169 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
170 if errorlevel 1 exit /b 1
172 echo.Build finished. The text files are in %BUILDDIR%/text.
177 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
178 if errorlevel 1 exit /b 1
180 echo.Build finished. The manual pages are in %BUILDDIR%/man.
184 if "%1" == "texinfo" (
185 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
186 if errorlevel 1 exit /b 1
188 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
192 if "%1" == "gettext" (
193 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
194 if errorlevel 1 exit /b 1
196 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
200 if "%1" == "changes" (
201 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
202 if errorlevel 1 exit /b 1
204 echo.The overview file is in %BUILDDIR%/changes.
208 if "%1" == "linkcheck" (
209 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
210 if errorlevel 1 exit /b 1
212 echo.Link check complete; look for any errors in the above output ^
213 or in %BUILDDIR%/linkcheck/output.txt.
217 if "%1" == "doctest" (
218 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
219 if errorlevel 1 exit /b 1
221 echo.Testing of doctests in the sources finished, look at the ^
222 results in %BUILDDIR%/doctest/output.txt.
227 %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
228 if errorlevel 1 exit /b 1
230 echo.Build finished. The XML files are in %BUILDDIR%/xml.
234 if "%1" == "pseudoxml" (
235 %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
236 if errorlevel 1 exit /b 1
238 echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.