Project

General

Profile

Statistics
| Revision:

root / trunk / docs / make.bat @ 11

History | View | Annotate | Download (3 KB)

1
@ECHO OFF
2

    
3
REM Command file for Sphinx documentation
4

    
5
set SPHINXBUILD=sphinx-build
6
set BUILDDIR=_build
7
set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
8
if NOT "%PAPER%" == "" (
9
	set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
10
)
11

    
12
if "%1" == "" goto help
13

    
14
if "%1" == "help" (
15
	: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
27
	goto end
28
)
29

    
30
if "%1" == "clean" (
31
	for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
32
	del /q /s %BUILDDIR%\*
33
	goto end
34
)
35

    
36
if "%1" == "html" (
37
	%SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
38
	echo.
39
	echo.Build finished. The HTML pages are in %BUILDDIR%/html.
40
	goto end
41
)
42

    
43
if "%1" == "dirhtml" (
44
	%SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
45
	echo.
46
	echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
47
	goto end
48
)
49

    
50
if "%1" == "pickle" (
51
	%SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
52
	echo.
53
	echo.Build finished; now you can process the pickle files.
54
	goto end
55
)
56

    
57
if "%1" == "json" (
58
	%SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
59
	echo.
60
	echo.Build finished; now you can process the JSON files.
61
	goto end
62
)
63

    
64
if "%1" == "htmlhelp" (
65
	%SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
66
	echo.
67
	echo.Build finished; now you can run HTML Help Workshop with the ^
68
.hhp project file in %BUILDDIR%/htmlhelp.
69
	goto end
70
)
71

    
72
if "%1" == "qthelp" (
73
	%SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
74
	echo.
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\LIDAR.qhcp
78
	echo.To view the help file:
79
	echo.^> assistant -collectionFile %BUILDDIR%\qthelp\LIDAR.ghc
80
	goto end
81
)
82

    
83
if "%1" == "latex" (
84
	%SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
85
	echo.
86
	echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
87
	goto end
88
)
89

    
90
if "%1" == "changes" (
91
	%SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
92
	echo.
93
	echo.The overview file is in %BUILDDIR%/changes.
94
	goto end
95
)
96

    
97
if "%1" == "linkcheck" (
98
	%SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
99
	echo.
100
	echo.Link check complete; look for any errors in the above output ^
101
or in %BUILDDIR%/linkcheck/output.txt.
102
	goto end
103
)
104

    
105
if "%1" == "doctest" (
106
	%SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
107
	echo.
108
	echo.Testing of doctests in the sources finished, look at the ^
109
results in %BUILDDIR%/doctest/output.txt.
110
	goto end
111
)
112

    
113
:end