1f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org@ECHO OFF 2f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 3f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgREM Command file for Sphinx documentation 4f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 5f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgset SPHINXBUILD=sphinx-build 6f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgset BUILDDIR=build 7f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgset ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source 8f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif NOT "%PAPER%" == "" ( 9f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 10f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 11f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 12f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "" goto help 13f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 14f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "help" ( 15f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org :help 16f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Please use `make ^<target^>` where ^<target^> is one of 17f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. html to make standalone HTML files 18f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. dirhtml to make HTML files named index.html in directories 19f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. pickle to make pickle files 20f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. json to make JSON files 21f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. htmlhelp to make HTML files and a HTML help project 22f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. qthelp to make HTML files and a qthelp project 23f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 24f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. changes to make an overview over all changed/added/deprecated items 25f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. linkcheck to check all external links for integrity 26f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. doctest to run all doctests embedded in the documentation if enabled 27f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 28f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 29f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 30f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "clean" ( 31f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 32f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org del /q /s %BUILDDIR%\* 33f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 34f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 35f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 36f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "html" ( 37f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 38f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 39f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished. The HTML pages are in %BUILDDIR%/html. 40f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 41f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 42f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 43f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "dirhtml" ( 44f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 45f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 46f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 47f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 48f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 49f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 50f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "pickle" ( 51f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 52f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 53f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished; now you can process the pickle files. 54f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 55f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 56f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 57f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "json" ( 58f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 59f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 60f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished; now you can process the JSON files. 61f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 62f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 63f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 64f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "htmlhelp" ( 65f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 66f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 67f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished; now you can run HTML Help Workshop with the ^ 68f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org.hhp project file in %BUILDDIR%/htmlhelp. 69f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 70f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 71f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 72f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "qthelp" ( 73f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 74f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 75f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished; now you can run "qcollectiongenerator" with the ^ 76f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org.qhcp project file in %BUILDDIR%/qthelp, like this: 77f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.^> qcollectiongenerator %BUILDDIR%\qthelp\Gallium.qhcp 78f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.To view the help file: 79f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.^> assistant -collectionFile %BUILDDIR%\qthelp\Gallium.ghc 80f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 81f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 82f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 83f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "latex" ( 84f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 85f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 86f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 87f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 88f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 89f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 90f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "changes" ( 91f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 92f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 93f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.The overview file is in %BUILDDIR%/changes. 94f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 95f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 96f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 97f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "linkcheck" ( 98f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 99f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 100f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Link check complete; look for any errors in the above output ^ 101f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgor in %BUILDDIR%/linkcheck/output.txt. 102f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 103f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 104f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 105f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgif "%1" == "doctest" ( 106f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 107f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo. 108f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org echo.Testing of doctests in the sources finished, look at the ^ 109f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.orgresults in %BUILDDIR%/doctest/output.txt. 110f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org goto end 111f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org) 112f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org 113f2ba7591b1407a7ee9209f842c50696914dc2dedkbr@chromium.org:end 114