annotate make.bat @ 213:0ea90a1819c2 default tip

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