3 REM Command file for Sphinx documentation
5 set SPHINXBUILD
=sphinx
-build
7 set ALLSPHINXOPTS
=-d
%BUILDDIR%/doctrees
%SPHINXOPTS% source
8 if NOT "%PAPER%" == "" (
9 set ALLSPHINXOPTS
=-D latex_paper_size
=%PAPER% %ALLSPHINXOPTS%
12 if "%1" == "" goto help
16 echo.Please
use `make ^
<target^
>` where ^
<target^
> is one of
17 echo. html to make standalone HTML
files
18 echo. dirhtml to make HTML
files named index.html in directories
19 echo. pickle to make pickle
files
20 echo. json to make JSON
files
21 echo. htmlhelp to make HTML
files and a HTML help project
22 echo. qthelp to make HTML
files and a qthelp project
23 echo. latex to make LaTeX
files, you can
set PAPER
=a4 or PAPER
=letter
24 echo. changes to make an overview over all changed
/added
/deprecated items
25 echo. linkcheck to check all external links
for integrity
26 echo. doctest to
run all doctests embedded in the documentation
if enabled
31 for /d
%%i in
(%BUILDDIR%\
*) do rmdir /q
/s
%%i
32 del /q
/s
%BUILDDIR%\
*
37 %SPHINXBUILD% -b html
%ALLSPHINXOPTS% %BUILDDIR%/html
39 echo.Build finished. The HTML pages are in
%BUILDDIR%/html.
43 if "%1" == "dirhtml" (
44 %SPHINXBUILD% -b dirhtml
%ALLSPHINXOPTS% %BUILDDIR%/dirhtml
46 echo.Build finished. The HTML pages are in
%BUILDDIR%/dirhtml.
51 %SPHINXBUILD% -b pickle
%ALLSPHINXOPTS% %BUILDDIR%/pickle
53 echo.Build finished
; now you can process the pickle
files.
58 %SPHINXBUILD% -b json
%ALLSPHINXOPTS% %BUILDDIR%/json
60 echo.Build finished
; now you can process the JSON
files.
64 if "%1" == "htmlhelp" (
65 %SPHINXBUILD% -b htmlhelp
%ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
67 echo.Build finished
; now you can
run HTML Help Workshop with the ^
68 .hhp project file in
%BUILDDIR%/htmlhelp.
73 %SPHINXBUILD% -b qthelp
%ALLSPHINXOPTS% %BUILDDIR%/qthelp
75 echo.Build finished
; now you can
run "qcollectiongenerator" with the ^
76 .qhcp project file in
%BUILDDIR%/qthelp
, like this
:
77 echo.^
> qcollectiongenerator
%BUILDDIR%\qthelp\Gallium.qhcp
78 echo.To
view the help file
:
79 echo.^
> assistant
-collectionFile
%BUILDDIR%\qthelp\Gallium.ghc
84 %SPHINXBUILD% -b latex
%ALLSPHINXOPTS% %BUILDDIR%/latex
86 echo.Build finished
; the LaTeX
files are in
%BUILDDIR%/latex.
90 if "%1" == "changes" (
91 %SPHINXBUILD% -b changes
%ALLSPHINXOPTS% %BUILDDIR%/changes
93 echo.The overview file is in
%BUILDDIR%/changes.
97 if "%1" == "linkcheck" (
98 %SPHINXBUILD% -b linkcheck
%ALLSPHINXOPTS% %BUILDDIR%/linkcheck
100 echo.Link check complete
; look
for any errors in the above output ^
101 or in
%BUILDDIR%/linkcheck
/output.txt.
105 if "%1" == "doctest" (
106 %SPHINXBUILD% -b doctest
%ALLSPHINXOPTS% %BUILDDIR%/doctest
108 echo.Testing of doctests in the sources finished
, look at the ^
109 results in
%BUILDDIR%/doctest
/output.txt.