docs: index generation
This commit is contained in:
parent
15e73d76ab
commit
baa6cbb316
3 changed files with 26 additions and 2 deletions
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -4,3 +4,4 @@ build/
|
|||
test/test_*
|
||||
nbproject
|
||||
docs/*.html
|
||||
docs/index.txt
|
||||
|
|
|
|||
|
|
@ -1,10 +1,11 @@
|
|||
|
||||
ASCIIDOC = asciidoc
|
||||
|
||||
HTML_DOCS = api-notify.html strbuf.html xalloc.html
|
||||
HTML_DOCS = index.html api-notify.html strbuf.html xalloc.html
|
||||
|
||||
ifndef VERBOSE
|
||||
QUIET_ASCIIDOC = @echo ' ' GEN $@;
|
||||
QUIET_SCRIPT = @echo ' ' GEN $@;
|
||||
endif
|
||||
|
||||
.PHONY : clean
|
||||
|
|
@ -14,5 +15,8 @@ html : $(HTML_DOCS)
|
|||
%.html : %.txt
|
||||
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -o $@ $<
|
||||
|
||||
index.txt :
|
||||
$(QUIET_SCRIPT)$(shell ./genindex.sh index.txt)
|
||||
|
||||
clean :
|
||||
$(RM) $(HTML_DOCS)
|
||||
$(RM) index.txt $(HTML_DOCS)
|
||||
|
|
|
|||
19
docs/genindex.sh
Executable file
19
docs/genindex.sh
Executable file
|
|
@ -0,0 +1,19 @@
|
|||
#!/bin/sh
|
||||
|
||||
if [ $# -lt 1 ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
(
|
||||
echo "Archived 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
|
||||
Reference in a new issue