350b15f9d1
The core library documentation has been converted to use asciidoc. It
provides better flexibility in creating documentation such as tables
and more powerful formatting rules.
The doxygen based API reference remains and three scripts have been
added to:
- gen-tags.sh: extract tag information from doxygen reference
- tags2dict.sh: generate a name=link dictionary file
- doxygen-link.py: replace all references in the asciidoc documentation
refering to API functions, struct, etc. with a link
into the doxygen API reference.
'make gendoc' continue to generate all documentation.
The following tools are required to generate documentation:
- asciidoc
- mscgen
- asciidoc mscgen plugin
- pygments
- xmlstarlet
20 lines
458 B
Python
Executable file
20 lines
458 B
Python
Executable file
#!/usr/bin/env python
|
|
|
|
import fileinput
|
|
import re
|
|
import sys
|
|
|
|
links = {}
|
|
|
|
for line in open(sys.argv[1], 'r'):
|
|
m = re.match('^([^=]+)=([^\n]+)$', line);
|
|
if m:
|
|
link = "<a href=\"" + m.group(2) + "\" class=\"dg\">" + m.group(1) + "</a>"
|
|
links[m.group(1)] = link
|
|
|
|
def translate(match):
|
|
return links[match.group(0)]
|
|
|
|
rc = re.compile('|'.join(map(re.escape, sorted(links, reverse=True))))
|
|
for line in open(sys.argv[2], 'r'):
|
|
print rc.sub(translate, line),
|