Mercurial > js4py

annotate Makefile @ 95:95ef8898e43e europython-2011

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add two sample JavaScript files and teaser.tex.
author Jonathan Fine <jfine@pytex.org>
date Sat, 02 Jul 2011 22:15:21 +0100
parents 53d9c4af9d90
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 # Makefile for Sphinx documentation
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
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
4 # You can set these variables from the command line.
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
5 SPHINXOPTS =
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
7 PAPER =
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
8 BUILDDIR = build
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
9
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
10 # Internal variables.
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
11 PAPEROPT_a4 = -D latex_paper_size=a4
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
12 PAPEROPT_letter = -D latex_paper_size=letter
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
13 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
14
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
15 .PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
16
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
17 help:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
18 @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
19 @echo " html to make standalone HTML files"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
20 @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
21 @echo " pickle to make pickle files"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
22 @echo " json to make JSON files"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
23 @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
24 @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
25 @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
26 @echo " changes to make an overview of all changed/added/deprecated items"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
27 @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
28 @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
29
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
30 clean:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
31 -rm -rf $(BUILDDIR)/*
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
32
54
53d9c4af9d90 gotcha.txt: Swapped 'Missing that' and 'Missing closure'. Improved Makefile.
Jonathan Fine <jfine@pytex.org>
parents: 0
diff changeset
33 source/gotcha.rst: txt/gotcha.txt
53d9c4af9d90 gotcha.txt: Swapped 'Missing that' and 'Missing closure'. Improved Makefile.
Jonathan Fine <jfine@pytex.org>
parents: 0
diff changeset
34 @python py/gotcha.py
53d9c4af9d90 gotcha.txt: Swapped 'Missing that' and 'Missing closure'. Improved Makefile.
Jonathan Fine <jfine@pytex.org>
parents: 0
diff changeset
35
53d9c4af9d90 gotcha.txt: Swapped 'Missing that' and 'Missing closure'. Improved Makefile.
Jonathan Fine <jfine@pytex.org>
parents: 0
diff changeset
36 html: source/gotcha.rst
0
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
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
41 dirhtml:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
42 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
43 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
44 @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
45
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
46 pickle:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
47 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
48 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
49 @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
50
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
51 json:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
52 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
53 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
54 @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
55
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
56 htmlhelp:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
57 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
58 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
59 @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
60 ".hhp project file in $(BUILDDIR)/htmlhelp."
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
61
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
62 qthelp:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
63 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
64 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
65 @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
66 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
67 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/JavaScriptforPythonProgrammers.qhcp"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
68 @echo "To view the help file:"
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
69 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/JavaScriptforPythonProgrammers.qhc"
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 latex:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
72 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
73 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
74 @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
75 @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
76 "run these through (pdf)latex."
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
77
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
78 changes:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
79 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
80 @echo
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
81 @echo "The overview file is in $(BUILDDIR)/changes."
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 linkcheck:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
84 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
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 "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
87 "or in $(BUILDDIR)/linkcheck/output.txt."
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 doctest:
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
90 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
e8d66dde1373 Used sphinx-quickstart to start the project.
Jonathan Fine <jfine@pytex.org>
parents:
diff changeset
91 @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
92 "results in $(BUILDDIR)/doctest/output.txt."