summaryrefslogtreecommitdiff
path: root/cesar
diff options
context:
space:
mode:
authorNicolas Schodet2012-03-27 15:24:40 +0200
committerNicolas Schodet2012-04-11 11:16:05 +0200
commit3ad45fcfc66d4eb35b62a948e571e3e7a43400b6 (patch)
tree5f95869e83200042cfa0349f7e98cb8b0a83faac /cesar
parent6d1fdc8751f16450eabde11afc01dfdb93ac1443 (diff)
cesar/lib/doc: use doc template
Diffstat (limited to 'cesar')
-rw-r--r--cesar/lib/doc/Makefile56
-rw-r--r--cesar/lib/doc/lib.rst21
-rw-r--r--cesar/lib/doc/lib.txt13
3 files changed, 35 insertions, 55 deletions
diff --git a/cesar/lib/doc/Makefile b/cesar/lib/doc/Makefile
index dcdc4a393f..4083c3f8d7 100644
--- a/cesar/lib/doc/Makefile
+++ b/cesar/lib/doc/Makefile
@@ -1,49 +1,21 @@
+BASE = ../../..
+
+DOCS = lib
+
PAGES = blk slab crc scenario
GRAPHS =
-DOTFLAGS =
-CONVERTFLAGS = -border 1 -bordercolor '\#d7d7d7'
+DEPS = $(PAGES:%=%.rst)
+EXTRA_CLEAN_FILES = $(PAGES:%=%.rst)
-TOOLS_DIR = ../../common/tools
-DOC_DIR = ../../common/doc
-SDL2DOT = $(TOOLS_DIR)/sdl2dot
-SDLPS = $(TOOLS_DIR)/sdl.ps
+include $(BASE)/common/doc/template/doc.mk
+
+TOOLS_DIR = $(BASE)/cesar/common/tools
+DOC_DIR = $(BASE)/cesar/common/doc
EXTRACT_DOC = $(DOC_DIR)/extractdoc
DOX2RST = $(DOC_DIR)/dox2rst -I ../scenario
-all: png rst
-
-png: $(GRAPHS:%=%.png)
-ps: $(GRAPHS:%=%.ps)
-
-%.png: %.ps
- convert $(CONVERTFLAGS) $< $@
-
-%.ps: %.dot Makefile
- dot $(DOTFLAGS) -Tps -l $(SDLPS) -o $@ $<
-
-%.dot: %.sdl
- $(SDL2DOT) $< > $@
-
-rst: lib.txt
-html: png lib.html
-odt: lib.odt
-
-lib.txt: $(PAGES:%=%.txt)
-lib.html: $(PAGES:%=%.txt)
-
-%.txt: ../%.h
- $(EXTRACT_DOC) $< | $(DOX2RST) -s 50 > $@
-%.txt: ../scenario/%.h
- $(EXTRACT_DOC) $< | $(DOX2RST) -s 50 > $@
-
-%.html: %.txt
- rst2html $< $@
-
-%.odt: %.txt
- rst2odt.py $< $@
-
-clean:
- rm -f $(GRAPHS:%=%.ps) $(GRAPHS:%=%.png)
- rm -f $(PAGES:%=%.txt) $(PAGES:%=%.html)
- rm -f lib.html lib.odt
+%.rst: ../%.h
+ $(EXTRACT_DOC) $< | $(DOX2RST) -w 100% > $@
+%.rst: ../scenario/%.h
+ $(EXTRACT_DOC) $< | $(DOX2RST) -w 100% > $@
diff --git a/cesar/lib/doc/lib.rst b/cesar/lib/doc/lib.rst
new file mode 100644
index 0000000000..2ad6a8884f
--- /dev/null
+++ b/cesar/lib/doc/lib.rst
@@ -0,0 +1,21 @@
+===========================
+ General purpose libraries
+===========================
+
+.. |title| replace:: General purpose libraries
+.. |version| vcs-version::
+
+.. include:: header.rst
+
+Introduction
+============
+
+This modules is composed of several general purpose libraries.
+
+.. include:: blk.rst
+
+.. include:: slab.rst
+
+.. include:: crc.rst
+
+.. include:: scenario.rst
diff --git a/cesar/lib/doc/lib.txt b/cesar/lib/doc/lib.txt
deleted file mode 100644
index dfabc755ab..0000000000
--- a/cesar/lib/doc/lib.txt
+++ /dev/null
@@ -1,13 +0,0 @@
-===========================
- General purpose libraries
-===========================
-
-This modules is composed of several general purpose libraries.
-
-.. include:: blk.txt
-
-.. include:: slab.txt
-
-.. include:: crc.txt
-
-.. include:: scenario.txt