Fio 3.15

[fio.git] / doc / make.bat

@ECHO OFF\r
\r
REM Command file for Sphinx documentation\r
\r
if "%SPHINXBUILD%" == "" (\r
	set SPHINXBUILD=sphinx-build\r
)\r
set BUILDDIR=_build\r
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .\r
set I18NSPHINXOPTS=%SPHINXOPTS% .\r
if NOT "%PAPER%" == "" (\r
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%\r
	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%\r
)\r
\r
if "%1" == "" goto help\r
\r
if "%1" == "help" (\r
	:help\r
	echo.Please use `make ^<target^>` where ^<target^> is one of\r
	echo.  html       to make standalone HTML files\r
	echo.  dirhtml    to make HTML files named index.html in directories\r
	echo.  singlehtml to make a single large HTML file\r
	echo.  pickle     to make pickle files\r
	echo.  json       to make JSON files\r
	echo.  htmlhelp   to make HTML files and a HTML help project\r
	echo.  qthelp     to make HTML files and a qthelp project\r
	echo.  devhelp    to make HTML files and a Devhelp project\r
	echo.  epub       to make an epub\r
	echo.  epub3      to make an epub3\r
	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter\r
	echo.  text       to make text files\r
	echo.  man        to make manual pages\r
	echo.  texinfo    to make Texinfo files\r
	echo.  gettext    to make PO message catalogs\r
	echo.  changes    to make an overview over all changed/added/deprecated items\r
	echo.  xml        to make Docutils-native XML files\r
	echo.  pseudoxml  to make pseudoxml-XML files for display purposes\r
	echo.  linkcheck  to check all external links for integrity\r
	echo.  doctest    to run all doctests embedded in the documentation if enabled\r
	echo.  coverage   to run coverage check of the documentation if enabled\r
	echo.  dummy      to check syntax errors of document sources\r
	goto end\r
)\r
\r
if "%1" == "clean" (\r
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i\r
	del /q /s %BUILDDIR%\*\r
	goto end\r
)\r
\r
\r
REM Check if sphinx-build is available and fallback to Python version if any\r
%SPHINXBUILD% 1>NUL 2>NUL\r
if errorlevel 9009 goto sphinx_python\r
goto sphinx_ok\r
\r
:sphinx_python\r
\r
set SPHINXBUILD=python -m sphinx.__init__\r
%SPHINXBUILD% 2> nul\r
if errorlevel 9009 (\r
	echo.\r
	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx\r
	echo.installed, then set the SPHINXBUILD environment variable to point\r
	echo.to the full path of the 'sphinx-build' executable. Alternatively you\r
	echo.may add the Sphinx directory to PATH.\r
	echo.\r
	echo.If you don't have Sphinx installed, grab it from\r
	echo.http://sphinx-doc.org/\r
	exit /b 1\r
)\r
\r
:sphinx_ok\r
\r
\r
if "%1" == "html" (\r
	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The HTML pages are in %BUILDDIR%/html.\r
	goto end\r
)\r
\r
if "%1" == "dirhtml" (\r
	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.\r
	goto end\r
)\r
\r
if "%1" == "singlehtml" (\r
	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.\r
	goto end\r
)\r
\r
if "%1" == "pickle" (\r
	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished; now you can process the pickle files.\r
	goto end\r
)\r
\r
if "%1" == "json" (\r
	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished; now you can process the JSON files.\r
	goto end\r
)\r
\r
if "%1" == "htmlhelp" (\r
	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished; now you can run HTML Help Workshop with the ^\r
.hhp project file in %BUILDDIR%/htmlhelp.\r
	goto end\r
)\r
\r
if "%1" == "qthelp" (\r
	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished; now you can run "qcollectiongenerator" with the ^\r
.qhcp project file in %BUILDDIR%/qthelp, like this:\r
	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\fio.qhcp\r
	echo.To view the help file:\r
	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\fio.ghc\r
	goto end\r
)\r
\r
if "%1" == "devhelp" (\r
	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished.\r
	goto end\r
)\r
\r
if "%1" == "epub" (\r
	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The epub file is in %BUILDDIR%/epub.\r
	goto end\r
)\r
\r
if "%1" == "epub3" (\r
	%SPHINXBUILD% -b epub3 %ALLSPHINXOPTS% %BUILDDIR%/epub3\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The epub3 file is in %BUILDDIR%/epub3.\r
	goto end\r
)\r
\r
if "%1" == "latex" (\r
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.\r
	goto end\r
)\r
\r
if "%1" == "latexpdf" (\r
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
	cd %BUILDDIR%/latex\r
	make all-pdf\r
	cd %~dp0\r
	echo.\r
	echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
	goto end\r
)\r
\r
if "%1" == "latexpdfja" (\r
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex\r
	cd %BUILDDIR%/latex\r
	make all-pdf-ja\r
	cd %~dp0\r
	echo.\r
	echo.Build finished; the PDF files are in %BUILDDIR%/latex.\r
	goto end\r
)\r
\r
if "%1" == "text" (\r
	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The text files are in %BUILDDIR%/text.\r
	goto end\r
)\r
\r
if "%1" == "man" (\r
	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The manual pages are in %BUILDDIR%/man.\r
	goto end\r
)\r
\r
if "%1" == "texinfo" (\r
	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.\r
	goto end\r
)\r
\r
if "%1" == "gettext" (\r
	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.\r
	goto end\r
)\r
\r
if "%1" == "changes" (\r
	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.The overview file is in %BUILDDIR%/changes.\r
	goto end\r
)\r
\r
if "%1" == "linkcheck" (\r
	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Link check complete; look for any errors in the above output ^\r
or in %BUILDDIR%/linkcheck/output.txt.\r
	goto end\r
)\r
\r
if "%1" == "doctest" (\r
	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Testing of doctests in the sources finished, look at the ^\r
results in %BUILDDIR%/doctest/output.txt.\r
	goto end\r
)\r
\r
if "%1" == "coverage" (\r
	%SPHINXBUILD% -b coverage %ALLSPHINXOPTS% %BUILDDIR%/coverage\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Testing of coverage in the sources finished, look at the ^\r
results in %BUILDDIR%/coverage/python.txt.\r
	goto end\r
)\r
\r
if "%1" == "xml" (\r
	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The XML files are in %BUILDDIR%/xml.\r
	goto end\r
)\r
\r
if "%1" == "pseudoxml" (\r
	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.\r
	goto end\r
)\r
\r
if "%1" == "dummy" (\r
	%SPHINXBUILD% -b dummy %ALLSPHINXOPTS% %BUILDDIR%/dummy\r
	if errorlevel 1 exit /b 1\r
	echo.\r
	echo.Build finished. Dummy builder generates no files.\r
	goto end\r
)\r
\r
:end\r