Mercurial > mxd2map
annotate doku/Makefile @ 265:4ca47adee224
Merged with Stephans commit.
author | Raimund Renkert <rrenkert@intevation.de> |
---|---|
date | Thu, 08 Sep 2011 15:06:40 +0200 |
parents | 4dc2b9aa3c57 |
children |
rev | line source |
---|---|
256
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
1 # |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
2 # Copyright (c) 2011 by Intevation GmbH, Germany <info@intevation.de> |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
3 # |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
4 # This file is part of MXD2map. |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
5 # |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
6 # This program is free software under the LGPL (>=v2.1) |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
7 # Read the file LICENCE.txt coming with the software for details |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
8 # or visit http://www.gnu.org/licenses/ if it does not exist. |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
9 # |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
10 # MXD2map has been developed on behalf of the |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
11 # Bundesamt fuer Seeschifffahrt und Hydrographie (BSH) in Hamburg |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
12 # by Intevation GmbH. |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
13 # |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
14 # Authors: |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
15 # Raimund Renkert <raimund.renkert@intevation.de> |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
16 # Bjoern Schilberg <bjoern.schilberg@intevation.de> |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
17 # Stephan Holl <stephan.holl@intevation.de> |
4dc2b9aa3c57
Added LGPL header.
raimund renkert <raimund.renkert@intevation.de>
parents:
231
diff
changeset
|
18 |
139
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
19 # Makefile for Sphinx documentation |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
20 # |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
21 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
22 # 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
|
23 SPHINXOPTS = |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
24 SPHINXBUILD = sphinx-build |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
25 PAPER = |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
26 BUILDDIR = build |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
27 MAKE = make |
219
f13f51627f07
Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents:
188
diff
changeset
|
28 WEBSITE = ../website/documentation |
139
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
29 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
30 # Internal variables. |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
31 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
|
32 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
|
33 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
|
34 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
35 .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
|
36 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
37 help: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
38 @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
|
39 @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
|
40 @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
|
41 @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
|
42 @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
|
43 @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
|
44 @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
|
45 @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
|
46 @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
|
47 @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
|
48 @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
|
49 @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
|
50 @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
|
51 @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
|
52 @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
|
53 @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
|
54 @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
|
55 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
56 clean: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
57 -rm -rf $(BUILDDIR)/* |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
58 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
59 html: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
60 $(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
|
61 $(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
|
62 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
63 @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
|
64 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
65 dirhtml: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
66 $(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
|
67 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
68 @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
|
69 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
70 singlehtml: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
71 $(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
|
72 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
73 @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
|
74 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
75 pickle: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
76 $(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
|
77 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
78 @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
|
79 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
80 json: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
81 $(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
|
82 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
83 @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
|
84 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
85 htmlhelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
86 $(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
|
87 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
88 @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
|
89 ".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
|
90 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
91 qthelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
92 $(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
|
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; 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
|
95 ".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
|
96 @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
|
97 @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
|
98 @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
|
99 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
100 devhelp: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
101 $(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
|
102 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
103 @echo "Build finished." |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
104 @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
|
105 @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
|
106 @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
|
107 @echo "# devhelp" |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
108 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
109 epub: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
110 $(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
|
111 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
112 @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
|
113 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
114 latex: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
115 $(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
|
116 $(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
|
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 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
|
119 @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
|
120 "(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
|
121 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
122 latexpdf: |
188
43f1cbdcd597
Modified and beautified the documentation:
Stephan Holl <stephan.holl@intevation.de>
parents:
139
diff
changeset
|
123 $(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
|
124 $(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
|
125 @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
|
126 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
|
127 @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
|
128 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
129 text: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
130 $(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
|
131 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
132 @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
|
133 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
134 man: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
135 $(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
|
136 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
137 @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
|
138 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
139 changes: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
140 $(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
|
141 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
142 @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
|
143 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
144 linkcheck: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
145 $(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
|
146 @echo |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
147 @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
|
148 "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
|
149 |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
150 doctest: |
2040463cb4f7
* doku/Makefile, doku/source/conf.py, doku/source/index.rst,
Stephan Holl <stephan.holl@intevation.de>
parents:
diff
changeset
|
151 $(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
|
152 @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
|
153 "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
|
154 |
f13f51627f07
Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents:
188
diff
changeset
|
155 online: html |
f13f51627f07
Adopted Makefiles to build documentation as well
Stephan Holl <stephan.holl@intevation.de>
parents:
188
diff
changeset
|
156 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
|
157 echo "DirectoryIndex index.html" >> $(WEBSITE)/.htaccess |