docs/Makefile@21884374edbb (annotated)
docs/Makefile
Sun, 15 Dec 2024 12:19:21 +0100
- author
- Mike Becker <universe@uap-core.de>
- date
- Sun, 15 Dec 2024 12:19:21 +0100
- changeset 1012
- 21884374edbb
- parent 765
- b5128bb44459
- permissions
- -rw-r--r--
add documentation - resolves #431
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
1 | # Copyright 2023 Mike Becker. All rights reserved. |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
2 | # |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
3 | # Redistribution and use in source and binary forms, with or without |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
4 | # modification, are permitted provided that the following conditions are met: |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
5 | # |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
6 | # 1. Redistributions of source code must retain the above copyright |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
7 | # notice, this list of conditions and the following disclaimer. |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
8 | # |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
9 | # 2. Redistributions in binary form must reproduce the above copyright |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
10 | # notice, this list of conditions and the following disclaimer in the |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
11 | # documentation and/or other materials provided with the distribution. |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
12 | # |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
13 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
14 | # AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
15 | # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
16 | # DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
17 | # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
18 | # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
19 | # SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
20 | # CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
21 | # OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
22 | # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
23 | |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
24 | include ../config.mk |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
25 | |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
26 | PAGES = index features install license modules-ucx2 |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
27 | DOCS_HTML = $(PAGES:%=$(docs_dir)/web/%.html) |
|
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
28 | DOCS_CSS = $(docs_dir)/web/ucx.css |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
29 | |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
30 | all: all-html all-api |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
31 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
32 | all-html: $(docs_dir)/web $(DOCS_HTML) $(DOCS_CSS) FORCE |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
33 | @echo "[ HTML Docs Generated ]" |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
34 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
35 | all-api: $(docs_dir)/web $(docs_dir)/web/api-2.1 $(docs_dir)/web/api FORCE |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
36 | @echo "[ API Docs Generated ]" |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
37 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
38 | $(docs_dir)/web/api-2.1: api-2.1 FORCE |
|
765
b5128bb44459
fix usage of COPYALL in Makefiles
Mike Becker <universe@uap-core.de>
parents:
754
diff
changeset
|
39 | $(MKDIR) $@ |
|
b5128bb44459
fix usage of COPYALL in Makefiles
Mike Becker <universe@uap-core.de>
parents:
754
diff
changeset
|
40 | $(COPYALL) $< "$@/.." |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
41 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
42 | $(docs_dir)/web/api: FORCE |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
43 | cd $(src_dir); $(DOXYGEN) |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
44 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
45 | $(docs_dir)/web: |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
46 | $(MKDIR) $@ |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
47 | |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
48 | $(DOCS_CSS): src/ucx.css |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
49 | $(COPYFILE) $< $@ |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
50 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
51 | $(docs_dir)/web/modules-ucx2.html: src/modules-ucx2.md |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
52 | $(PANDOC) -c ucx.css -B src/header-ucx2.html -A src/footer.html \ |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
53 | -T 'UAP Common Extensions' -o $@ $< |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
54 | |
|
754
4bc7d966c9db
add an uwproj based install target
Mike Becker <universe@uap-core.de>
parents:
753
diff
changeset
|
55 | $(docs_dir)/web/%.html: src/%.md |
|
753
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
56 | $(PANDOC) -c ucx.css -B src/header.html -A src/footer.html \ |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
57 | -T 'UAP Common Extensions' -o $@ $< |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
58 | |
|
24dc84788dee
replace most of the build system with uwproj
Mike Becker <universe@uap-core.de>
parents:
diff
changeset
|
59 | FORCE: |
