Blame docs/make.bat

Packit Service 7c31a4
@ECHO OFF
Packit Service 7c31a4

Packit Service 7c31a4
REM Command file for Sphinx documentation
Packit Service 7c31a4

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

Packit Service 7c31a4
if "%1" == "" goto help
Packit Service 7c31a4

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

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

Packit Service 7c31a4

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Packit Service 7c31a4
:end