Mercurial > mxd2map
annotate doku/Makefile @ 188:43f1cbdcd597
Modified and beautified the documentation:
* INSTALL.txt, doku/Makefile, doku/source/conf.py,
doku/source/functionality.txt, doku/source/index.txt,
doku/source/restrictions.txt, website/favicon.png, LICENCE.txt:
added more details to the content of the documentation. some more
configurations.
* doku/source/LICENCE.txt: New. Added a licence-text (symlinking
into the documentation).
* doku/source/_static/favicon.png,
doku/source/_static/logo_wide.png,
doku/source/_templates/indexsidebar.html,
doku/source/_templates/layout.html: Optic-cosmetics.
author | Stephan Holl <stephan.holl@intevation.de> |
---|---|
date | Wed, 20 Jul 2011 15:53:01 +0200 |
parents | 2040463cb4f7 |
children | f13f51627f07 |
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 |
139
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
10 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
11 # Internal variables. |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
12 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
|
13 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
|
14 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
|
15 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
16 .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
|
17 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
18 help: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
19 @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
|
20 @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
|
21 @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
|
22 @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
|
23 @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
|
24 @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
|
25 @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
|
26 @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
|
27 @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
|
28 @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
|
29 @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
|
30 @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
|
31 @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
|
32 @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
|
33 @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
|
34 @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
|
35 @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
|
36 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
37 clean: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
38 -rm -rf $(BUILDDIR)/* |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
39 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
40 html: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
41 $(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
|
42 $(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
|
43 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
44 @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
|
45 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
46 dirhtml: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
47 $(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
|
48 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
49 @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
|
50 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
51 singlehtml: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
52 $(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
|
53 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
54 @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
|
55 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
56 pickle: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
57 $(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
|
58 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
59 @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
|
60 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
61 json: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
62 $(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
|
63 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
64 @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
|
65 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
66 htmlhelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
67 $(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
|
68 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
69 @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
|
70 ".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
|
71 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
72 qthelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
73 $(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
|
74 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
75 @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
|
76 ".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
|
77 @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
|
78 @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
|
79 @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
|
80 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
81 devhelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
82 $(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
|
83 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
84 @echo "Build finished." |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
85 @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
|
86 @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
|
87 @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
|
88 @echo "# devhelp" |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
89 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
90 epub: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
91 $(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
|
92 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
93 @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
|
94 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
95 latex: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
96 $(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
|
97 $(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
|
98 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
99 @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
|
100 @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
|
101 "(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
|
102 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
103 latexpdf: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
104 $(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
|
105 $(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
|
106 @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
|
107 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
|
108 @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
|
109 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
110 text: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
111 $(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
|
112 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
113 @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
|
114 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
115 man: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
116 $(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
|
117 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
118 @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
|
119 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
120 changes: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
121 $(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
|
122 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
123 @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
|
124 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
125 linkcheck: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
126 $(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
|
127 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
128 @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
|
129 "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
|
130 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
131 doctest: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
132 $(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
|
133 @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
|
134 "results in $(BUILDDIR)/doctest/output.txt." |