annotate core-javascript/Makefile @ 201:b6864a86e876 default tip

Przetłumaczone getting-started
author Radomir Dopieralski <sheep-devel@sheep.art.pl>
date Sun, 15 Jul 2012 13:27:27 +0200
parents 0b029e4a12f2
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
1 # Makefile for Sphinx documentation
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
2 #
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
3
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
4 # You can set these variables from the command line.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
5 SPHINXOPTS =
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
7 PAPER =
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
8 BUILDDIR = _build
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
9
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
10 # Internal variables.
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
11 PAPEROPT_a4 = -D latex_paper_size=a4
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
12 PAPEROPT_letter = -D latex_paper_size=letter
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
14
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
15 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
16
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
17 help:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
18 @echo "Please use \`make <target>' where <target> is one of"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
19 @echo " html to make standalone HTML files"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
20 @echo " dirhtml to make HTML files named index.html in directories"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
21 @echo " singlehtml to make a single large HTML file"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
22 @echo " pickle to make pickle files"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
23 @echo " json to make JSON files"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
24 @echo " htmlhelp to make HTML files and a HTML help project"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
25 @echo " qthelp to make HTML files and a qthelp project"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
26 @echo " devhelp to make HTML files and a Devhelp project"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
27 @echo " epub to make an epub"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
28 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
29 @echo " latexpdf to make LaTeX files and run them through pdflatex"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
30 @echo " text to make text files"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
31 @echo " man to make manual pages"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
32 @echo " gettext to make PO message catalogs"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
33 @echo " changes to make an overview of all changed/added/deprecated items"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
34 @echo " linkcheck to check all external links for integrity"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
35 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
36
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
37 clean:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
38 -rm -rf $(BUILDDIR)/*
116
a21e804c9b2a Add getting-started.rst.
jf3243
parents: 97
diff changeset
39 -rm -rf core-javascript-work.zip
a21e804c9b2a Add getting-started.rst.
jf3243
parents: 97
diff changeset
40 zip -r core-javascript-work.zip core-javascript-work
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
41
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
42 html:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
43 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
126
0b029e4a12f2 Incorporate counters-example.rst into documentation.
Jonathan Fine <jfine@pytex.org>
parents: 116
diff changeset
44 -cp -r core-javascript-work/ $(BUILDDIR)/html/
97
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
45 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
46 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
47
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
48 dirhtml:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
49 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
50 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
51 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
52
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
53 singlehtml:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
54 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
55 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
56 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
57
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
58 pickle:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
59 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
60 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
61 @echo "Build finished; now you can process the pickle files."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
62
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
63 json:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
64 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
65 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
66 @echo "Build finished; now you can process the JSON files."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
67
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
68 htmlhelp:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
69 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
70 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
71 @echo "Build finished; now you can run HTML Help Workshop with the" \
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
72 ".hhp project file in $(BUILDDIR)/htmlhelp."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
73
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
74 qthelp:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
75 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
76 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
77 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
78 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
79 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/CoreJavaScript.qhcp"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
80 @echo "To view the help file:"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
81 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/CoreJavaScript.qhc"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
82
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
83 devhelp:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
84 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
85 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
86 @echo "Build finished."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
87 @echo "To view the help file:"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
88 @echo "# mkdir -p $$HOME/.local/share/devhelp/CoreJavaScript"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
89 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/CoreJavaScript"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
90 @echo "# devhelp"
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
91
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
92 epub:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
93 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
94 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
95 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
96
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
97 latex:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
98 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
99 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
100 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
101 @echo "Run \`make' in that directory to run these through (pdf)latex" \
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
102 "(use \`make latexpdf' here to do that automatically)."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
103
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
104 latexpdf:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
105 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
106 @echo "Running LaTeX files through pdflatex..."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
107 make -C $(BUILDDIR)/latex all-pdf
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
108 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
109
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
110 text:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
111 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
112 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
113 @echo "Build finished. The text files are in $(BUILDDIR)/text."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
114
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
115 man:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
116 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
117 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
118 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
119
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
120 gettext:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
121 $(SPHINXBUILD) -b gettext $(ALLSPHINXOPTS) $(BUILDDIR)/locale
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
122 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
123 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
124
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
125 changes:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
126 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
127 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
128 @echo "The overview file is in $(BUILDDIR)/changes."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
129
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
130 linkcheck:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
131 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
132 @echo
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
133 @echo "Link check complete; look for any errors in the above output " \
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
134 "or in $(BUILDDIR)/linkcheck/output.txt."
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
135
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
136 doctest:
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
137 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
138 @echo "Testing of doctests in the sources finished, look at the " \
0c7473ebce62 Create stub files using sphinx-quickstart.
jf3243
parents:
diff changeset
139 "results in $(BUILDDIR)/doctest/output.txt."