3 REM Command file for Sphinx documentation
5 if "%SPHINXBUILD%" == "" (
6 set SPHINXBUILD
=sphinx
-build
9 set HTMLDIR
=..
/html
/numpy
10 set ALLSPHINXOPTS
=-d
%BUILDDIR%/doctrees
%SPHINXOPTS% .
11 if NOT "%PAPER%" == "" (
12 set ALLSPHINXOPTS
=-D latex_paper_size
=%PAPER% %ALLSPHINXOPTS%
15 if "%1" == "" goto help
19 echo.Please
use `make ^
<target^
>` where ^
<target^
> is one of
20 echo. html to make standalone HTML
files
21 echo. dirhtml to make HTML
files named index.html in directories
22 echo. singlehtml to make a single large HTML file
23 echo. pickle to make pickle
files
24 echo. json to make JSON
files
25 echo. htmlhelp to make HTML
files and a HTML help project
26 echo. qthelp to make HTML
files and a qthelp project
27 echo. devhelp to make HTML
files and a Devhelp project
28 echo. epub to make an epub
29 echo. latex to make LaTeX
files, you can
set PAPER
=a4 or PAPER
=letter
30 echo. text to make text
files
31 echo. man to make manual pages
32 echo. changes to make an overview over all changed
/added
/deprecated items
33 echo. linkcheck to check all external links
for integrity
34 echo. doctest to
run all doctests embedded in the documentation
if enabled
39 for /d
%%i in
(%BUILDDIR%\
*) do rmdir /q
/s
%%i
40 del /q
/s
%BUILDDIR%\
*
45 %SPHINXBUILD% -b html
%ALLSPHINXOPTS% %HTMLDIR%
46 if errorlevel 1 exit /b
1
48 echo.Build finished. The HTML pages are in
%HTMLDIR%.
52 if "%1" == "dirhtml" (
53 %SPHINXBUILD% -b dirhtml
%ALLSPHINXOPTS% %BUILDDIR%/dirhtml
54 if errorlevel 1 exit /b
1
56 echo.Build finished. The HTML pages are in
%BUILDDIR%/dirhtml.
60 if "%1" == "singlehtml" (
61 %SPHINXBUILD% -b singlehtml
%ALLSPHINXOPTS% %BUILDDIR%/singlehtml
62 if errorlevel 1 exit /b
1
64 echo.Build finished. The HTML pages are in
%BUILDDIR%/singlehtml.
69 %SPHINXBUILD% -b pickle
%ALLSPHINXOPTS% %BUILDDIR%/pickle
70 if errorlevel 1 exit /b
1
72 echo.Build finished
; now you can process the pickle
files.
77 %SPHINXBUILD% -b json
%ALLSPHINXOPTS% %BUILDDIR%/json
78 if errorlevel 1 exit /b
1
80 echo.Build finished
; now you can process the JSON
files.
84 if "%1" == "htmlhelp" (
85 %SPHINXBUILD% -b htmlhelp
%ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
86 if errorlevel 1 exit /b
1
88 echo.Build finished
; now you can
run HTML Help Workshop with the ^
89 .hhp project file in
%BUILDDIR%/htmlhelp.
94 %SPHINXBUILD% -b qthelp
%ALLSPHINXOPTS% %BUILDDIR%/qthelp
95 if errorlevel 1 exit /b
1
97 echo.Build finished
; now you can
run "qcollectiongenerator" with the ^
98 .qhcp project file in
%BUILDDIR%/qthelp
, like this
:
99 echo.^
> qcollectiongenerator
%BUILDDIR%\qthelp\BoostNumPy.qhcp
100 echo.To
view the help file
:
101 echo.^
> assistant
-collectionFile
%BUILDDIR%\qthelp\BoostNumPy.ghc
105 if "%1" == "devhelp" (
106 %SPHINXBUILD% -b devhelp
%ALLSPHINXOPTS% %BUILDDIR%/devhelp
107 if errorlevel 1 exit /b
1
114 %SPHINXBUILD% -b epub
%ALLSPHINXOPTS% %BUILDDIR%/epub
115 if errorlevel 1 exit /b
1
117 echo.Build finished. The epub file is in
%BUILDDIR%/epub.
122 %SPHINXBUILD% -b latex
%ALLSPHINXOPTS% %BUILDDIR%/latex
123 if errorlevel 1 exit /b
1
125 echo.Build finished
; the LaTeX
files are in
%BUILDDIR%/latex.
130 %SPHINXBUILD% -b text
%ALLSPHINXOPTS% %BUILDDIR%/text
131 if errorlevel 1 exit /b
1
133 echo.Build finished. The text
files are in
%BUILDDIR%/text.
138 %SPHINXBUILD% -b man
%ALLSPHINXOPTS% %BUILDDIR%/man
139 if errorlevel 1 exit /b
1
141 echo.Build finished. The manual pages are in
%BUILDDIR%/man.
145 if "%1" == "changes" (
146 %SPHINXBUILD% -b changes
%ALLSPHINXOPTS% %BUILDDIR%/changes
147 if errorlevel 1 exit /b
1
149 echo.The overview file is in
%BUILDDIR%/changes.
153 if "%1" == "linkcheck" (
154 %SPHINXBUILD% -b linkcheck
%ALLSPHINXOPTS% %BUILDDIR%/linkcheck
155 if errorlevel 1 exit /b
1
157 echo.Link check complete
; look
for any errors in the above output ^
158 or in
%BUILDDIR%/linkcheck
/output.txt.
162 if "%1" == "doctest" (
163 %SPHINXBUILD% -b doctest
%ALLSPHINXOPTS% %BUILDDIR%/doctest
164 if errorlevel 1 exit /b
1
166 echo.Testing of doctests in the sources finished
, look at the ^
167 results in
%BUILDDIR%/doctest
/output.txt.