aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/Makefile.am
diff options
context:
space:
mode:
authorRobin Haberkorn <robin.haberkorn@googlemail.com>2013-02-26 16:35:08 +0100
committerRobin Haberkorn <robin.haberkorn@googlemail.com>2013-03-16 18:07:30 +0100
commit8a0a8a49472dc879188215838e83ae00fc78fb3f (patch)
tree3f9f8700fb62ccd7f7c5d083c18098ecd670ae2d /doc/Makefile.am
parent1c4127666adfded4f7caf58fc30040cb235107d1 (diff)
downloadsciteco-8a0a8a49472dc879188215838e83ae00fc78fb3f.tar.gz
first draft of TECO command documentation generator
* the language reference is a manually written man-page template * containing special references for generated documentation (\#$...) * SciTECO script generate-docs.tes extracts TECO comments (/*$ ... */) from all source files and transforms them to Troff requests that are inserted into the document template. * TECO doc comments are a rather sophisticated markup: * first part until empty line is called header: simplified command syntax descriptions * the rest is called body: <identifier> is automatically underlined, empty lines generate new paragraphs, lines beginning with "-" or numbers denote an indented unordered or numbered list item. * regular Troff requests/macros can be used for more sophisticated markup * since Autoconf substitutions are performed on the generated man-page, @VARIABLEs@ may be used in doc comments as well
Diffstat (limited to 'doc/Makefile.am')
-rw-r--r--doc/Makefile.am11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 48ab9b8..7ed5a5c 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -4,6 +4,17 @@ man_MANS = sciteco.1
EXTRA_DIST = sciteco.1.in
CLEANFILES = sciteco.1
+man_MANS += sciteco.7
+EXTRA_DIST += sciteco.7.template
+CLEANFILES += sciteco.7 sciteco.7.in
+SOURCES = $(wildcard @top_srcdir@/src/*.cpp)
+
+EXTRA_DIST += generate-docs.tes
+
+%.in : %.template generate-docs.tes $(SOURCES)
+ $(BOOTSTRAP_SCITECO) -m @srcdir@/generate-docs.tes \
+ $@ $< $(SOURCES)
+
#
# Doxygen processing (do not install or distribute)
#