Blame docs/make.bat

Packit b5b901
@ECHO OFF
Packit b5b901

Packit b5b901
REM Command file for Sphinx documentation
Packit b5b901

Packit b5b901
if "%SPHINXBUILD%" == "" (
Packit b5b901
	set SPHINXBUILD=sphinx-build
Packit b5b901
)
Packit b5b901
set BUILDDIR=build
Packit b5b901
set SRCDIR=src
Packit b5b901
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% %SRCDIR%
Packit b5b901
set I18NSPHINXOPTS=%SPHINXOPTS% %SRCDIR%
Packit b5b901
if NOT "%PAPER%" == "" (
Packit b5b901
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
Packit b5b901
	set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "" goto help
Packit b5b901

Packit b5b901
if "%1" == "help" (
Packit b5b901
	:help
Packit b5b901
	echo.Please use `make ^<target^>` where ^<target^> is one of
Packit b5b901
	echo.  html       to make standalone HTML files
Packit b5b901
	echo.  dirhtml    to make HTML files named index.html in directories
Packit b5b901
	echo.  singlehtml to make a single large HTML file
Packit b5b901
	echo.  pickle     to make pickle files
Packit b5b901
	echo.  json       to make JSON files
Packit b5b901
	echo.  htmlhelp   to make HTML files and a HTML help project
Packit b5b901
	echo.  qthelp     to make HTML files and a qthelp project
Packit b5b901
	echo.  devhelp    to make HTML files and a Devhelp project
Packit b5b901
	echo.  epub       to make an epub
Packit b5b901
	echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
Packit b5b901
	echo.  text       to make text files
Packit b5b901
	echo.  man        to make manual pages
Packit b5b901
	echo.  texinfo    to make Texinfo files
Packit b5b901
	echo.  gettext    to make PO message catalogs
Packit b5b901
	echo.  changes    to make an overview over all changed/added/deprecated items
Packit b5b901
	echo.  xml        to make Docutils-native XML files
Packit b5b901
	echo.  pseudoxml  to make pseudoxml-XML files for display purposes
Packit b5b901
	echo.  linkcheck  to check all external links for integrity
Packit b5b901
	echo.  doctest    to run all doctests embedded in the documentation if enabled
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "clean" (
Packit b5b901
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
Packit b5b901
	del /q /s %BUILDDIR%\*
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901

Packit b5b901
%SPHINXBUILD% 2> nul
Packit b5b901
if errorlevel 9009 (
Packit b5b901
	echo.
Packit b5b901
	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
Packit b5b901
	echo.installed, then set the SPHINXBUILD environment variable to point
Packit b5b901
	echo.to the full path of the 'sphinx-build' executable. Alternatively you
Packit b5b901
	echo.may add the Sphinx directory to PATH.
Packit b5b901
	echo.
Packit b5b901
	echo.If you don't have Sphinx installed, grab it from
Packit b5b901
	echo.http://sphinx-doc.org/
Packit b5b901
	exit /b 1
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "html" (
Packit b5b901
	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "dirhtml" (
Packit b5b901
	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "singlehtml" (
Packit b5b901
	%SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "pickle" (
Packit b5b901
	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; now you can process the pickle files.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "json" (
Packit b5b901
	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; now you can process the JSON files.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "htmlhelp" (
Packit b5b901
	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; now you can run HTML Help Workshop with the ^
Packit b5b901
.hhp project file in %BUILDDIR%/htmlhelp.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "qthelp" (
Packit b5b901
	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; now you can run "qcollectiongenerator" with the ^
Packit b5b901
.qhcp project file in %BUILDDIR%/qthelp, like this:
Packit b5b901
	echo.^> qcollectiongenerator %BUILDDIR%\qthelp\libuv.qhcp
Packit b5b901
	echo.To view the help file:
Packit b5b901
	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\libuv.ghc
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "devhelp" (
Packit b5b901
	%SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "epub" (
Packit b5b901
	%SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The epub file is in %BUILDDIR%/epub.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "latex" (
Packit b5b901
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "latexpdf" (
Packit b5b901
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
Packit b5b901
	cd %BUILDDIR%/latex
Packit b5b901
	make all-pdf
Packit b5b901
	cd %BUILDDIR%/..
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "latexpdfja" (
Packit b5b901
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
Packit b5b901
	cd %BUILDDIR%/latex
Packit b5b901
	make all-pdf-ja
Packit b5b901
	cd %BUILDDIR%/..
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished; the PDF files are in %BUILDDIR%/latex.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "text" (
Packit b5b901
	%SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The text files are in %BUILDDIR%/text.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "man" (
Packit b5b901
	%SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The manual pages are in %BUILDDIR%/man.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "texinfo" (
Packit b5b901
	%SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "gettext" (
Packit b5b901
	%SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "changes" (
Packit b5b901
	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.The overview file is in %BUILDDIR%/changes.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "linkcheck" (
Packit b5b901
	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Link check complete; look for any errors in the above output ^
Packit b5b901
or in %BUILDDIR%/linkcheck/output.txt.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "doctest" (
Packit b5b901
	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Testing of doctests in the sources finished, look at the ^
Packit b5b901
results in %BUILDDIR%/doctest/output.txt.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "xml" (
Packit b5b901
	%SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The XML files are in %BUILDDIR%/xml.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
if "%1" == "pseudoxml" (
Packit b5b901
	%SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml
Packit b5b901
	if errorlevel 1 exit /b 1
Packit b5b901
	echo.
Packit b5b901
	echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml.
Packit b5b901
	goto end
Packit b5b901
)
Packit b5b901

Packit b5b901
:end