3 REM Command file for Sphinx documentation
5 set SPHINXBUILD=sphinx-build
6 set ALLSPHINXOPTS=-d _build/doctrees %SPHINXOPTS% .
7 if NOT "%PAPER%" == "" (
8 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
11 if "%1" == "" goto help
15 echo.Please use `make ^<target^>` where ^<target^> is one of
16 echo. html to make standalone HTML files
17 echo. dirhtml to make HTML files named index.html in directories
18 echo. pickle to make pickle files
19 echo. json to make JSON files
20 echo. htmlhelp to make HTML files and a HTML help project
21 echo. qthelp to make HTML files and a qthelp project
22 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
23 echo. changes to make an overview over all changed/added/deprecated items
24 echo. linkcheck to check all external links for integrity
25 echo. doctest to run all doctests embedded in the documentation if enabled
30 for /d %%i in (_build\*) do rmdir /q /s %%i
36 %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
38 echo.Build finished. The HTML pages are in _build/html.
42 if "%1" == "dirhtml" (
43 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml
45 echo.Build finished. The HTML pages are in _build/dirhtml.
50 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
52 echo.Build finished; now you can process the pickle files.
57 %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
59 echo.Build finished; now you can process the JSON files.
63 if "%1" == "htmlhelp" (
64 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
66 echo.Build finished; now you can run HTML Help Workshop with the ^
67 .hhp project file in _build/htmlhelp.
72 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
74 echo.Build finished; now you can run "qcollectiongenerator" with the ^
75 .qhcp project file in _build/qthelp, like this:
76 echo.^> qcollectiongenerator _build\qthelp\git-cola.qhcp
77 echo.To view the help file:
78 echo.^> assistant -collectionFile _build\qthelp\git-cola.ghc
83 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex
85 echo.Build finished; the LaTeX files are in _build/latex.
89 if "%1" == "changes" (
90 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
92 echo.The overview file is in _build/changes.
96 if "%1" == "linkcheck" (
97 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
99 echo.Link check complete; look for any errors in the above output ^
100 or in _build/linkcheck/output.txt.
104 if "%1" == "doctest" (
105 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
107 echo.Testing of doctests in the sources finished, look at the ^
108 results in _build/doctest/output.txt.