aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/.gitignore2
-rw-r--r--doc/Makefile31
-rw-r--r--doc/build.mk62
-rw-r--r--doc/manual_src/Makefile20
4 files changed, 64 insertions, 51 deletions
diff --git a/doc/.gitignore b/doc/.gitignore
new file mode 100644
index 0000000..65250b0
--- /dev/null
+++ b/doc/.gitignore
@@ -0,0 +1,2 @@
+/manual/
+/jsdoc/
diff --git a/doc/Makefile b/doc/Makefile
deleted file mode 100644
index a37743e..0000000
--- a/doc/Makefile
+++ /dev/null
@@ -1,31 +0,0 @@
-JSDOC_DIR=jsdoc
-MANUAL_DIR=manual
-MANUAL_SRC=manual_src
-MAN_DEPS=$(MANUAL_SRC)/*.md $(MANUAL_SRC)/figures/*.png
-JSDOC_TOOLKIT=../build/jsdoc
-
-all: jsdoc man
-
-.PHONY: jsdoc
-jsdoc: ../contexts/data/fiveui/injected/prelude.js ../contexts/data/fiveui/injected/jquery-plugins.js
- @$(JSDOC_TOOLKIT) ../contexts/data/fiveui/injected/prelude.js ../contexts/data/fiveui/injected/jquery-plugins.js
-
-.PHONY: man
-man: web-manual
-
-$(MANUAL_DIR):
- @mkdir -p $(MANUAL_DIR)
-
-.PHONY: web-manual
-web-manual: $(MANUAL_DIR) $(MAN_DEPS)
- @make -C $(MANUAL_SRC)
- @cp -r $(MANUAL_SRC)/figures $(MANUAL_DIR)
-# @cp -r $(MANUAL_SRC)/images $(MANUAL_DIR)
- @cp $(MANUAL_SRC)/*.html $(MANUAL_DIR)
- @cp $(MANUAL_SRC)/*.css $(MANUAL_DIR)
-# @mv $(MANUAL_SRC)/*.html $(MANUAL_DIR)
-
-clean:
- @make -C $(MANUAL_SRC) clean
- @$(RM) -r $(JSDOC_DIR)
- @$(RM) -r $(MANUAL_DIR)
diff --git a/doc/build.mk b/doc/build.mk
new file mode 100644
index 0000000..136048b
--- /dev/null
+++ b/doc/build.mk
@@ -0,0 +1,62 @@
+
+jsdoc-dir := $(build-dir)/jsdoc
+manual-dir := $(build-dir)/manual
+manual-src := $(path)/manual_src
+
+pandoc := $(shell which pandoc 2>/dev/null)
+
+
+# HTML Generation ##############################################################
+
+# Use pandoc to generate HTML
+quiet_cmd_pandoc = PANDOC $@
+ cmd_pandoc = $(pandoc) $< -o $@ -s --highlight-style=kate \
+ --template=$(manual-src)/template.html
+
+manual-deps := $(patsubst $(manual-src)/%.md,$(manual-dir)/%.html,\
+ $(wildcard $(manual-src)/*.md))
+
+$(manual-deps): $(manual-dir)/%.html: $(manual-src)/%.md | $(manual-dir)
+ $(call cmd,pandoc)
+
+
+# HTML Manual ##################################################################
+
+ifneq "$(pandoc)" ""
+all: web-manual
+else
+$(warning pandoc not found, not building the manual)
+endif
+
+.PHONY: web-manual
+web-manual: $(manual-deps) | $(manual-dir)/css-images $(manual-dir)/figures
+
+
+# Stage Directories ############################################################
+
+$(manual-dir): | $(build-dir)
+ $(call cmd,mkdir)
+
+define stage-doc-dir
+$(manual-dir)/$(notdir $1): DIR := $1
+$(manual-dir)/$(notdir $1): $(wildcard $1/*) | $(manual-dir)
+ $$(call cmd,copydir)
+
+web-manual: $(manual-dir)/$(notdir $1)
+endef
+
+$(eval $(call stage-doc-dir,$(manual-src)/css-images))
+$(eval $(call stage-doc-dir,$(manual-src)/figures))
+$(eval $(call stage-doc-dir,$(path)/css))
+$(eval $(call stage-doc-dir,$(path)/images))
+
+
+
+# JsDoc Documentation ##########################################################
+
+all: | $(jsdoc-dir)
+
+$(jsdoc-dir): $(topdir)/contexts/data/fiveui/injected/prelude.js \
+ $(topdir)/contexts/data/fiveui/injected/jquery-plugins.js \
+ | $(build-dir)
+ $(call label,JSDOC)$(topdir)/tools/bin/jsdoc $^ $(if $(Q),>/dev/null)
diff --git a/doc/manual_src/Makefile b/doc/manual_src/Makefile
deleted file mode 100644
index e924b3f..0000000
--- a/doc/manual_src/Makefile
+++ /dev/null
@@ -1,20 +0,0 @@
-
-LIBDIR=../..
-#LIBDIR=../../../FiveUI-github
-HEADER=galois-github-header.txt
-BEFORE_BODY=galois-github-before-body.txt
-AFTER_BODY=galois-github-after-body.txt
-#CSS=$(LIBDIR)/galois-github.css
-HTML5=-t html5
-
-DOCS := $(patsubst %.md,%.html,$(wildcard *.md))
-
-all: $(DOCS)
-
-clean:
- $(RM) $(DOCS)
-
-%.html: %.md
- pandoc $< -o $@ -s --highlight-style=kate --template=template.html #$(HTML5)
-# pandoc $< -o $@ -s --highlight-style=kate -H $(HEADER) -B $(BEFORE_BODY) -A $(AFTER_BODY) -c $(CSS) $(HTML5)
-