1 | @ECHO OFF
|
---|
2 |
|
---|
3 | REM Command file for Sphinx documentation
|
---|
4 |
|
---|
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%
|
---|
9 | )
|
---|
10 |
|
---|
11 | if "%1" == "" goto help
|
---|
12 |
|
---|
13 | if "%1" == "help" (
|
---|
14 | :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
|
---|
26 | goto end
|
---|
27 | )
|
---|
28 |
|
---|
29 | if "%1" == "clean" (
|
---|
30 | for /d %%i in (_build\*) do rmdir /q /s %%i
|
---|
31 | del /q /s _build\*
|
---|
32 | goto end
|
---|
33 | )
|
---|
34 |
|
---|
35 | if "%1" == "html" (
|
---|
36 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% _build/html
|
---|
37 | echo.
|
---|
38 | echo.Build finished. The HTML pages are in _build/html.
|
---|
39 | goto end
|
---|
40 | )
|
---|
41 |
|
---|
42 | if "%1" == "dirhtml" (
|
---|
43 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% _build/dirhtml
|
---|
44 | echo.
|
---|
45 | echo.Build finished. The HTML pages are in _build/dirhtml.
|
---|
46 | goto end
|
---|
47 | )
|
---|
48 |
|
---|
49 | if "%1" == "pickle" (
|
---|
50 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% _build/pickle
|
---|
51 | echo.
|
---|
52 | echo.Build finished; now you can process the pickle files.
|
---|
53 | goto end
|
---|
54 | )
|
---|
55 |
|
---|
56 | if "%1" == "json" (
|
---|
57 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% _build/json
|
---|
58 | echo.
|
---|
59 | echo.Build finished; now you can process the JSON files.
|
---|
60 | goto end
|
---|
61 | )
|
---|
62 |
|
---|
63 | if "%1" == "htmlhelp" (
|
---|
64 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% _build/htmlhelp
|
---|
65 | echo.
|
---|
66 | echo.Build finished; now you can run HTML Help Workshop with the ^
|
---|
67 | .hhp project file in _build/htmlhelp.
|
---|
68 | goto end
|
---|
69 | )
|
---|
70 |
|
---|
71 | if "%1" == "qthelp" (
|
---|
72 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% _build/qthelp
|
---|
73 | echo.
|
---|
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\Pester.qhcp
|
---|
77 | echo.To view the help file:
|
---|
78 | echo.^> assistant -collectionFile _build\qthelp\Pester.ghc
|
---|
79 | goto end
|
---|
80 | )
|
---|
81 |
|
---|
82 | if "%1" == "latex" (
|
---|
83 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% _build/latex
|
---|
84 | echo.
|
---|
85 | echo.Build finished; the LaTeX files are in _build/latex.
|
---|
86 | goto end
|
---|
87 | )
|
---|
88 |
|
---|
89 | if "%1" == "changes" (
|
---|
90 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% _build/changes
|
---|
91 | echo.
|
---|
92 | echo.The overview file is in _build/changes.
|
---|
93 | goto end
|
---|
94 | )
|
---|
95 |
|
---|
96 | if "%1" == "linkcheck" (
|
---|
97 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% _build/linkcheck
|
---|
98 | echo.
|
---|
99 | echo.Link check complete; look for any errors in the above output ^
|
---|
100 | or in _build/linkcheck/output.txt.
|
---|
101 | goto end
|
---|
102 | )
|
---|
103 |
|
---|
104 | if "%1" == "doctest" (
|
---|
105 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% _build/doctest
|
---|
106 | echo.
|
---|
107 | echo.Testing of doctests in the sources finished, look at the ^
|
---|
108 | results in _build/doctest/output.txt.
|
---|
109 | goto end
|
---|
110 | )
|
---|
111 |
|
---|
112 | :end
|
---|