docs/Makefile

Thu, 25 Jan 2024 22:05:48 +0100

author
Mike Becker <universe@uap-core.de>
date
Thu, 25 Jan 2024 22:05:48 +0100
changeset 819
5da2ead43077
parent 765
b5128bb44459
permissions
-rw-r--r--

rename cx_array_copy_result to just cx_array_result

# Copyright 2023 Mike Becker. All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

include ../config.mk

PAGES = index features install license modules-ucx2
DOCS_HTML = $(PAGES:%=$(docs_dir)/web/%.html)
DOCS_CSS  = $(docs_dir)/web/ucx.css

all: all-html all-api

all-html: $(docs_dir)/web $(DOCS_HTML) $(DOCS_CSS) FORCE
	@echo "[ HTML Docs Generated ]"

all-api: $(docs_dir)/web $(docs_dir)/web/api-2.1 $(docs_dir)/web/api FORCE
	@echo "[ API Docs Generated ]"

$(docs_dir)/web/api-2.1: api-2.1 FORCE
	$(MKDIR) $@
	$(COPYALL) $< "$@/.."

$(docs_dir)/web/api: FORCE
	cd $(src_dir); $(DOXYGEN)

$(docs_dir)/web:
	$(MKDIR) $@

$(DOCS_CSS): src/ucx.css
	$(COPYFILE) $< $@

$(docs_dir)/web/modules-ucx2.html: src/modules-ucx2.md
	$(PANDOC) -c ucx.css -B src/header-ucx2.html -A src/footer.html \
		-T 'UAP Common Extensions' -o $@ $<

$(docs_dir)/web/%.html: src/%.md
	$(PANDOC) -c ucx.css -B src/header.html -A src/footer.html \
		-T 'UAP Common Extensions' -o $@ $<

FORCE:

mercurial