Generally working version.

[wolnelektury.git] / doc / make.bat

diff --git a/doc/make.bat b/doc/make.bat
index e3c48ca..9b0792f 100644 (file)
--- a/doc/make.bat
+++ b/doc/make.bat
@@ -2,8 +2,11 @@
 
 REM Command file for Sphinx documentation
 
 
 REM Command file for Sphinx documentation
 

-set SPHINXBUILD=sphinx-build
-set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% .
+if "%SPHINXBUILD%" == "" (
+       set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=_build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .

 if NOT "%PAPER%" == "" (
        set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 )
 if NOT "%PAPER%" == "" (
        set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
 )


@@ -13,99 +16,154 @@ if "%1" == "" goto help
 if "%1" == "help" (
        :help
        echo.Please use `make ^<target^>` where ^<target^> is one of
 if "%1" == "help" (
        :help
        echo.Please use `make ^<target^>` where ^<target^> is one of

-       echo.  html      to make standalone HTML files
-       echo.  dirhtml   to make HTML files named index.html in directories
-       echo.  pickle    to make pickle files
-       echo.  json      to make JSON files
-       echo.  htmlhelp  to make HTML files and a HTML help project
-       echo.  qthelp    to make HTML files and a qthelp project
-       echo.  latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter
-       echo.  changes   to make an overview over all changed/added/deprecated items
-       echo.  linkcheck to check all external links for integrity
-       echo.  doctest   to run all doctests embedded in the documentation if enabled
+       echo.  html       to make standalone HTML files
+       echo.  dirhtml    to make HTML files named index.html in directories
+       echo.  singlehtml to make a single large HTML file
+       echo.  pickle     to make pickle files
+       echo.  json       to make JSON files
+       echo.  htmlhelp   to make HTML files and a HTML help project
+       echo.  qthelp     to make HTML files and a qthelp project
+       echo.  devhelp    to make HTML files and a Devhelp project
+       echo.  epub       to make an epub
+       echo.  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+       echo.  text       to make text files
+       echo.  man        to make manual pages
+       echo.  changes    to make an overview over all changed/added/deprecated items
+       echo.  linkcheck  to check all external links for integrity
+       echo.  doctest    to run all doctests embedded in the documentation if enabled

        goto end
 )
 
 if "%1" == "clean" (
        goto end
 )
 
 if "%1" == "clean" (

-       for /d %%i in (_build\*) do rmdir /q /s %%i
-       del /q /s _build\*
+       for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+       del /q /s %BUILDDIR%\*

        goto end
 )
 
 if "%1" == "html" (
        goto end
 )
 
 if "%1" == "html" (

-       %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
+       %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+       if errorlevel 1 exit /b 1

        echo.
        echo.

-       echo.Build finished. The HTML pages are in _build/html.
+       echo.Build finished. The HTML pages are in %BUILDDIR%/html.

        goto end
 )
 
 if "%1" == "dirhtml" (
        goto end
 )
 
 if "%1" == "dirhtml" (

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

        echo.
        echo.

-       echo.Build finished. The HTML pages are in _build/dirhtml.
+       echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.

        goto end
 )
 
 if "%1" == "pickle" (
        goto end
 )
 
 if "%1" == "pickle" (

-       %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
+       %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+       if errorlevel 1 exit /b 1

        echo.
        echo.Build finished; now you can process the pickle files.
        goto end
 )
 
 if "%1" == "json" (
        echo.
        echo.Build finished; now you can process the pickle files.
        goto end
 )
 
 if "%1" == "json" (

-       %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
+       %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+       if errorlevel 1 exit /b 1

        echo.
        echo.Build finished; now you can process the JSON files.
        goto end
 )
 
 if "%1" == "htmlhelp" (
        echo.
        echo.Build finished; now you can process the JSON files.
        goto end
 )
 
 if "%1" == "htmlhelp" (

-       %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
+       %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+       if errorlevel 1 exit /b 1

        echo.
        echo.Build finished; now you can run HTML Help Workshop with the ^
        echo.
        echo.Build finished; now you can run HTML Help Workshop with the ^

-.hhp project file in _build/htmlhelp.
+.hhp project file in %BUILDDIR%/htmlhelp.

        goto end
 )
 
 if "%1" == "qthelp" (
        goto end
 )
 
 if "%1" == "qthelp" (

-       %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
+       %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+       if errorlevel 1 exit /b 1

        echo.
        echo.Build finished; now you can run "qcollectiongenerator" with the ^
        echo.
        echo.Build finished; now you can run "qcollectiongenerator" with the ^

-.qhcp project file in _build/qthelp, like this:
-       echo.^> qcollectiongenerator _build\qthelp\WolneLektury.pl.qhcp
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+       echo.^> qcollectiongenerator %BUILDDIR%\qthelp\WolneLektury.qhcp

        echo.To view the help file:
        echo.To view the help file:

-       echo.^> assistant -collectionFile _build\qthelp\WolneLektury.pl.ghc
+       echo.^> assistant -collectionFile %BUILDDIR%\qthelp\WolneLektury.ghc
+       goto end
+)
+
+if "%1" == "devhelp" (
+       %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+       if errorlevel 1 exit /b 1
+       echo.
+       echo.Build finished.
+       goto end
+)
+
+if "%1" == "epub" (
+       %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+       if errorlevel 1 exit /b 1
+       echo.
+       echo.Build finished. The epub file is in %BUILDDIR%/epub.

        goto end
 )
 
 if "%1" == "latex" (
        goto end
 )
 
 if "%1" == "latex" (

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

        echo.
        echo.

-       echo.Build finished; the LaTeX files are in _build/latex.
+       echo.Build finished. The manual pages are in %BUILDDIR%/man.

        goto end
 )
 
 if "%1" == "changes" (
        goto end
 )
 
 if "%1" == "changes" (

-       %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
+       %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+       if errorlevel 1 exit /b 1

        echo.
        echo.

-       echo.The overview file is in _build/changes.
+       echo.The overview file is in %BUILDDIR%/changes.

        goto end
 )
 
 if "%1" == "linkcheck" (
        goto end
 )
 
 if "%1" == "linkcheck" (

-       %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
+       %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+       if errorlevel 1 exit /b 1

        echo.
        echo.Link check complete; look for any errors in the above output ^
        echo.
        echo.Link check complete; look for any errors in the above output ^

-or in _build/linkcheck/output.txt.
+or in %BUILDDIR%/linkcheck/output.txt.

        goto end
 )
 
 if "%1" == "doctest" (
        goto end
 )
 
 if "%1" == "doctest" (

-       %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
+       %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+       if errorlevel 1 exit /b 1

        echo.
        echo.Testing of doctests in the sources finished, look at the ^
        echo.
        echo.Testing of doctests in the sources finished, look at the ^

-results in _build/doctest/output.txt.
+results in %BUILDDIR%/doctest/output.txt.

        goto end
 )
 
        goto end
 )