annotate doku/Makefile @ 232:4fc0635000d6

Merged with upstream
author Stephan Holl <stephan.holl@intevation.de>
date Mon, 01 Aug 2011 10:56:15 +0200
parents 656da3f693b8
children 4dc2b9aa3c57
rev   line source
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
1 # Makefile for Sphinx documentation
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
2 #
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
3
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
4 # You can set these variables from the command line.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
5 SPHINXOPTS =
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
6 SPHINXBUILD = sphinx-build
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
7 PAPER =
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
8 BUILDDIR = build
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 139
diff changeset
9 MAKE = make
219
f13f51627f07 Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
10 WEBSITE = ../website/documentation
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
11
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
12 # Internal variables.
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
13 PAPEROPT_a4 = -D latex_paper_size=a4
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
14 PAPEROPT_letter = -D latex_paper_size=letter
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
15 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
16
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
17 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
18
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
19 help:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
20 @echo "Please use \`make <target>' where <target> is one of"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
21 @echo " html to make standalone HTML files"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
22 @echo " dirhtml to make HTML files named index.html in directories"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
23 @echo " singlehtml to make a single large HTML file"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
24 @echo " pickle to make pickle files"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
25 @echo " json to make JSON files"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
26 @echo " htmlhelp to make HTML files and a HTML help project"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
27 @echo " qthelp to make HTML files and a qthelp project"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
28 @echo " devhelp to make HTML files and a Devhelp project"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
29 @echo " epub to make an epub"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
30 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
31 @echo " latexpdf to make LaTeX files and run them through pdflatex"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
32 @echo " text to make text files"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
33 @echo " man to make manual pages"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
34 @echo " changes to make an overview of all changed/added/deprecated items"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
35 @echo " linkcheck to check all external links for integrity"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
36 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
37
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
38 clean:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
39 -rm -rf $(BUILDDIR)/*
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
40
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
41 html:
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 139
diff changeset
42 $(MAKE) -C funktionsweise all
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
43 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
44 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
45 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
46
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
47 dirhtml:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
48 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
49 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
50 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
51
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
52 singlehtml:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
53 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
54 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
55 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
56
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
57 pickle:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
58 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
59 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
60 @echo "Build finished; now you can process the pickle files."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
61
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
62 json:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
63 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
64 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
65 @echo "Build finished; now you can process the JSON files."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
66
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
67 htmlhelp:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
68 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
69 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
70 @echo "Build finished; now you can run HTML Help Workshop with the" \
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
71 ".hhp project file in $(BUILDDIR)/htmlhelp."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
72
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
73 qthelp:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
74 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
75 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
76 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
77 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
78 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/MXD2map.qhcp"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
79 @echo "To view the help file:"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
80 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/MXD2map.qhc"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
81
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
82 devhelp:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
83 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
84 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
85 @echo "Build finished."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
86 @echo "To view the help file:"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
87 @echo "# mkdir -p $$HOME/.local/share/devhelp/MXD2map"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
88 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/MXD2map"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
89 @echo "# devhelp"
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
90
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
91 epub:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
92 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
93 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
94 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
95
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
96 latex:
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 139
diff changeset
97 $(MAKE) -C funktionsweise all
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
98 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
99 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
100 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
101 @echo "Run \`make' in that directory to run these through (pdf)latex" \
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
102 "(use \`make latexpdf' here to do that automatically)."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
103
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
104 latexpdf:
188
43f1cbdcd597 Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents: 139
diff changeset
105 $(MAKE) -C funktionsweise all
139
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
106 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
107 @echo "Running LaTeX files through pdflatex..."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
108 make -C $(BUILDDIR)/latex all-pdf
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
109 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
110
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
111 text:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
112 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
113 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
114 @echo "Build finished. The text files are in $(BUILDDIR)/text."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
115
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
116 man:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
117 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
118 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
119 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
120
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
121 changes:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
122 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
123 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
124 @echo "The overview file is in $(BUILDDIR)/changes."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
125
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
126 linkcheck:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
127 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
128 @echo
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
129 @echo "Link check complete; look for any errors in the above output " \
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
130 "or in $(BUILDDIR)/linkcheck/output.txt."
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
131
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
132 doctest:
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
133 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
134 @echo "Testing of doctests in the sources finished, look at the " \
2040463cb4f7 * doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff changeset
135 "results in $(BUILDDIR)/doctest/output.txt."
219
f13f51627f07 Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
136
f13f51627f07 Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
137 online: html
f13f51627f07 Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents: 188
diff changeset
138 rm -rf $(WEBSITE) && mkdir -p $(WEBSITE) && cp -r build/html/* $(WEBSITE)
231
656da3f693b8 Adding a directory-index to the documentation
Stephan Holl <stephan.holl@intevation.de>
parents: 219
diff changeset
139 echo "DirectoryIndex index.html" >> $(WEBSITE)/.htaccess
This site is hosted by Intevation GmbH (Datenschutzerklärung und Impressum | Privacy Policy and Imprint)