annotate docs/make.bat @ 314:0687bb650118

begin new docs
author catherine@dellzilla
date Wed, 10 Feb 2010 14:07:01 -0500
parents
children
rev   line source
314
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
1 @ECHO OFF
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
2
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
3 REM Command file for Sphinx documentation
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
4
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
5 set SPHINXBUILD=sphinx-build
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
6 set BUILDDIR=_build
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
7 set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
8 if NOT "%PAPER%" == "" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
9 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
10 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
11
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
12 if "%1" == "" goto help
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
13
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
14 if "%1" == "help" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
15 :help
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
16 echo.Please use `make ^<target^>` where ^<target^> is one of
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
17 echo. html to make standalone HTML files
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
18 echo. dirhtml to make HTML files named index.html in directories
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
19 echo. pickle to make pickle files
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
20 echo. json to make JSON files
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
21 echo. htmlhelp to make HTML files and a HTML help project
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
22 echo. qthelp to make HTML files and a qthelp project
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
23 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
24 echo. changes to make an overview over all changed/added/deprecated items
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
25 echo. linkcheck to check all external links for integrity
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
26 echo. doctest to run all doctests embedded in the documentation if enabled
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
27 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
28 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
29
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
30 if "%1" == "clean" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
31 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
32 del /q /s %BUILDDIR%\*
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
33 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
34 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
35
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
36 if "%1" == "html" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
37 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
38 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
39 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
40 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
41 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
42
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
43 if "%1" == "dirhtml" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
44 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
45 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
46 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
47 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
48 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
49
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
50 if "%1" == "pickle" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
51 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
52 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
53 echo.Build finished; now you can process the pickle files.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
54 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
55 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
56
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
57 if "%1" == "json" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
58 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
59 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
60 echo.Build finished; now you can process the JSON files.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
61 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
62 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
63
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
64 if "%1" == "htmlhelp" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
65 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
66 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
67 echo.Build finished; now you can run HTML Help Workshop with the ^
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
68 .hhp project file in %BUILDDIR%/htmlhelp.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
69 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
70 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
71
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
72 if "%1" == "qthelp" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
73 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
74 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
75 echo.Build finished; now you can run "qcollectiongenerator" with the ^
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
76 .qhcp project file in %BUILDDIR%/qthelp, like this:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
77 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\cmd2.qhcp
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
78 echo.To view the help file:
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
79 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\cmd2.ghc
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
80 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
81 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
82
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
83 if "%1" == "latex" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
84 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
85 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
86 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
87 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
88 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
89
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
90 if "%1" == "changes" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
91 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
92 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
93 echo.The overview file is in %BUILDDIR%/changes.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
94 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
95 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
96
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
97 if "%1" == "linkcheck" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
98 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
99 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
100 echo.Link check complete; look for any errors in the above output ^
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
101 or in %BUILDDIR%/linkcheck/output.txt.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
102 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
103 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
104
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
105 if "%1" == "doctest" (
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
106 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
107 echo.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
108 echo.Testing of doctests in the sources finished, look at the ^
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
109 results in %BUILDDIR%/doctest/output.txt.
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
110 goto end
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
111 )
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
112
0687bb650118 begin new docs
catherine@dellzilla
parents:
diff changeset
113 :end