Archived
1
0
Fork 0

Changed the documentation structure

This commit is contained in:
Fredric N 2011-01-22 14:37:14 +01:00 committed by Henrik Hautakoski
parent 8be6c69e97
commit 3c0e4e6470
13 changed files with 34 additions and 8 deletions

2
.gitignore vendored
View file

@ -3,5 +3,3 @@ archived
Makefile.local.mk Makefile.local.mk
test/test_* test/test_*
nbproject nbproject
docs/*.html
docs/index.txt

2
docs/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
*.html
index.txt

View file

@ -1,9 +1,8 @@
ASCIIDOC = asciidoc ASCIIDOC = asciidoc
SOURCE_DOCS = $(subst index.txt,,$(wildcard *.txt)) DOCS = $(filter-out index.txt, $(wildcard *.txt))
TECH_DOCS = $(filter-out technical/index.txt, $(wildcard technical/*.txt))
HTML_DOCS = index.html $(patsubst %.txt,%.html,$(SOURCE_DOCS))
ifndef VERBOSE ifndef VERBOSE
QUIET_ASCIIDOC = @echo ' ' GEN $@; QUIET_ASCIIDOC = @echo ' ' GEN $@;
@ -12,13 +11,17 @@ endif
.PHONY : clean .PHONY : clean
all : html all : html
html : $(HTML_DOCS) html : index.html
technical : technical/index.html
%.html : %.txt %.html : %.txt
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -o $@ $< $(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -o $@ $<
index.txt : $(SOURCE_DOCS) index.txt : $(patsubst %.txt,%.html,$(DOCS))
$(QUIET_SCRIPT)$(shell ./genindex.sh index.txt) $(QUIET_SCRIPT)$(shell ./genindex.sh index.txt)
technical/index.txt : $(patsubst %.txt,%.html,$(TECH_DOCS))
$(QUIET_SCRIPT)cd technical && ./genindex.sh index.txt
clean : clean :
$(RM) index.txt *.html $(RM) index.txt *.html technical/index.txt technical/*.html

2
docs/technical/.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
*.html
index.txt

21
docs/technical/genindex.sh Executable file
View file

@ -0,0 +1,21 @@
#!/bin/sh
if [ $# -lt 1 ]; then
exit 1
fi
(
echo "Archived API Documentation"
echo "--------------------------"
for DOC in `ls *.txt`; do
if [ "$DOC" = "$1" ]; then
continue
fi
display=$(sed -e 1q "${DOC}")
link=${DOC%.txt}.html
echo "* link:${link}[${display}]"
done
) > $1