Changed the documentation structure
This commit is contained in:
parent
8be6c69e97
commit
3c0e4e6470
13 changed files with 34 additions and 8 deletions
2
docs/.gitignore
vendored
Normal file
2
docs/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
*.html
|
||||
index.txt
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
|
||||
ASCIIDOC = asciidoc
|
||||
|
||||
SOURCE_DOCS = $(subst index.txt,,$(wildcard *.txt))
|
||||
|
||||
HTML_DOCS = index.html $(patsubst %.txt,%.html,$(SOURCE_DOCS))
|
||||
DOCS = $(filter-out index.txt, $(wildcard *.txt))
|
||||
TECH_DOCS = $(filter-out technical/index.txt, $(wildcard technical/*.txt))
|
||||
|
||||
ifndef VERBOSE
|
||||
QUIET_ASCIIDOC = @echo ' ' GEN $@;
|
||||
|
|
@ -12,13 +11,17 @@ endif
|
|||
|
||||
.PHONY : clean
|
||||
all : html
|
||||
html : $(HTML_DOCS)
|
||||
html : index.html
|
||||
technical : technical/index.html
|
||||
|
||||
%.html : %.txt
|
||||
$(QUIET_ASCIIDOC)$(ASCIIDOC) -b xhtml11 -o $@ $<
|
||||
|
||||
index.txt : $(SOURCE_DOCS)
|
||||
index.txt : $(patsubst %.txt,%.html,$(DOCS))
|
||||
$(QUIET_SCRIPT)$(shell ./genindex.sh index.txt)
|
||||
|
||||
technical/index.txt : $(patsubst %.txt,%.html,$(TECH_DOCS))
|
||||
$(QUIET_SCRIPT)cd technical && ./genindex.sh index.txt
|
||||
|
||||
clean :
|
||||
$(RM) index.txt *.html
|
||||
$(RM) index.txt *.html technical/index.txt technical/*.html
|
||||
|
|
|
|||
2
docs/technical/.gitignore
vendored
Normal file
2
docs/technical/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
*.html
|
||||
index.txt
|
||||
21
docs/technical/genindex.sh
Executable file
21
docs/technical/genindex.sh
Executable 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
|
||||
Reference in a new issue