libucw documentation: index

Lists modules and definitions

diff --git a/ucw/doc/Makefile b/ucw/doc/Makefile
index 69146fd0336505f6c135986965786eacfb176d8f..a299b03d289aba64b13f29c41752bc0798a22aec 100644 (file)
--- a/ucw/doc/Makefile
+++ b/ucw/doc/Makefile
@@ -1,5 +1,12 @@
-# Makefile for the UCW GetOpt Library (c) 2007 Pavel Charvat <pchar@ucw.cz>
+# Makefile for the UCW documentation, (c) 2008 Michal Vaner <vorner@ucw.cz>
 
 DIRS+=ucw/doc
 
-DOCS+=$(addprefix $(o)/ucw/doc/,fastbuf.html)
+UCW_DOCS=fastbuf
+UCW_INDEX=$(o)/ucw/doc/index.html
+
+$(UCW_INDEX): DOC_HEAD:=$(s)/ucw/doc/index.txt
+$(UCW_INDEX): DOC_LIST:=$(patsubst %,$(o)/ucw/doc/%.deflist,$(UCW_DOCS))
+
+DOCS+=$(addprefix $(o)/ucw/doc/,$(addsuffix .html,$(UCW_DOCS)))
+DOC_INDECES+=$(UCW_INDEX)

diff --git a/ucw/doc/index.txt b/ucw/doc/index.txt
new file mode 100644 (file)
index 0000000..0a80fa0
--- /dev/null
+++ b/ucw/doc/index.txt
@@ -0,0 +1,13 @@
+UCW libraries
+=============
+
+////
+TODO: Some general description, what the libraries are, why, etc...
+////
+
+Modules
+-------
+- <<fastbuf:,Fastbufs>>
+
+Definitions
+-----------