# 2. Regenerating header and/or footer
#
# If needed, the doxy-header.html and/or doxy-footer.html file will be
-# regenerated. The dependencies are *not* complete, just adding a new
-# subdirectory sadly does not automatically update the header (which
-# contains the menu)
-#
-# The header and/or footer are written are generated from templates
+# regenerated. The header and/or footer are generated from templates
# using a simple python based templating system called yaptu which is
# included in doclib/.
#
Import('env')
-import SENFSCons
+import SENFSCons, datetime, os
###########################################################################
# Naja ... etwas rumgehackt aber was solls ...
global EXTRA_MODULES
mods = {}
- pathbase = len(env.Dir('#').abspath)+1
+ pathbase = env.Dir('#/senf').abspath
+ pathbasel = len(pathbase)+1
for module in env.Alias('all_docs')[0].sources:
if module.name != 'html.stamp' : continue
- mods[module.dir.dir.dir.abspath] = [ module.dir.dir.dir.name,
- module.dir.abspath[pathbase:],
+ if not module.dir.dir.dir.abspath.startswith(pathbase): continue
+ mods[module.dir.dir.dir.abspath] = [ module.dir.dir.dir.abspath[pathbasel:].replace('/','_'),
+ module.dir.dir.dir.name,
+ module.dir.abspath[pathbasel:],
0 ]
rv = []
for mod in keys:
i = 0
while i < len(rv):
- if len(rv[i]) > pathbase and mod.startswith(rv[i] + '/'):
- level = mods[rv[i]][2] + 1
+ if len(rv[i]) > pathbasel and mod.startswith(rv[i] + '/'):
+ level = mods[rv[i]][-1] + 1
i += 1
while i < len(rv) and mods[rv[i]][2] >= level:
i += 1
rv[i:i] = [ mod ]
- mods[mod][2] = level
+ mods[mod][-1] = level
break
i += 1
if i == len(rv):
rv.append(mod)
- for mod in keys:
- if mods[mod][2] == 0:
- mods[mod][0] = 'lib' + mods[mod][0]
-
- n = 0
- for name,path in EXTRA_MODULES:
- path = env.Dir(path).dir.dir.abspath
- i = 0
- while i < len(rv):
- if rv[i] == path:
- mods[rv[i]][0] = name
- m = 1
- while i+m < len(rv) and mods[rv[i+m]][2] > mods[rv[i]][2]:
- m += 1
- rv[n:n] = rv[i:i+m]
- rv[i+m:i+2*m] = []
- i += m
- n += m
- else:
- i += 1
-
return ( tuple(mods[mod]) for mod in rv )
def indices():
if doc.name == "search.idx" ]
def writeTemplate(target = None, source = None, env = None):
- file(target[0].abspath,"w").write(yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary()))
+ file(target[0].abspath,"w").write(processTemplate(env))
+
+def processTemplate(env):
+ return yaptu.process(str(env['TEMPLATE']), globals(), env.Dictionary())
writeTemplate = env.Action(writeTemplate, varlist = [ 'TEMPLATE' ])
###########################################################################
-# Extra documentation modules which are handled (named) different from
-# library modules
-EXTRA_MODULES = [
- ('Overview', '#/doc/html'),
- ('Examples', '#/Examples/doc/html'),
- ('HowTos', '#/HowTos/doc/html'),
- ('SENFSCons', '#/senfscons/doc/html') ]
-
HEADER = """<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">ChangeLog</a></li>
<li><a class="ext" href="http://svn.berlios.de/viewcvs/senf/trunk/">Browse SVN</a></li>
<li><a class="ext" href="http://developer.berlios.de/bugs/?group_id=7489">Bug Tracker</a></li>
- <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
</ul>
</div>
</div>
<div id="content1">
<div id="content2">
<div class="tabs menu">
+ <li class="Overview level0"><a href="@TOPDIR@/doc/html/index.html">Overview</a></li>
+ <li class="Examples level0"><a href="@TOPDIR@/Examples/doc/html/index.html">Examples</a></li>
+ <li class="HowTos level0"><a href="@TOPDIR@/HowTos/doc/html/index.html">HowTos</a></li>
+ <li class="glossary level0"><a href="@TOPDIR@/doc/html/glossary.html">Glossary</a></li>
+ </div>
+ <div class="tabs menu">
<ul>
-{{ for name, path, level in modules():
- <li class="${name} level${level}"><a href="@TOPDIR@/${path}/index.html">${name}</a></li>
+{{ for id, name, path, level in modules():
+ <li class="${id} level${level}"><a href="@TOPDIR@/senf/${path}/index.html">${name}</a></li>
}}
- <li class="glossary level0"><a href="@TOPDIR@/doc/html/glossary.html">Glossary</a></li>
</ul>
</div>"""
}
?>"""
-env.Command('doxy-header.html', 'SConscript', writeTemplate,
- TEMPLATE = Literal(HEADER),
- TITLE = "Documentation and API reference")
-env.Command('doxy-footer.html', 'SConscript', writeTemplate,
- TEMPLATE = Literal(FOOTER))
+env.SetDefault(
+ DOXYGEN = "doxygen"
+)
+
+env.Replace(
+ DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE",
+)
+
+env.Append( ENV = {
+ 'TODAY' : str(datetime.date.today()),
+ 'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'),
+ 'DOXYGEN' : env.File(env['DOXYGEN']).abspath,
+})
+
+env.PhonyTarget('linklint', [], [
+ 'rm -rf linklint',
+ 'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
+ '[ ! -r linklint/errorX.html ] || python doclib/linklint_addnames.py <linklint/errorX.html >linklint/errorX.html.new',
+ '[ ! -r linklint/errorX.html.new ] || mv linklint/errorX.html.new linklint/errorX.html',
+ '[ ! -r linklint/errorAX.html ] || python doclib/linklint_addnames.py <linklint/errorAX.html >linklint/errorAX.html.new',
+ '[ ! -r linklint/errorAX.html.new ] || mv linklint/errorAX.html.new linklint/errorAX.html',
+ 'echo -e "\\nLokal link check results: linklint/index.html\\nRemote link check results: linklint/urlindex.html\\n"',
+])
+
+env.PhonyTarget('fixlinks', [], [
+ 'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
+])
+
+
+header = env.Command('doxy-header.html', 'SConscript', writeTemplate,
+ TEMPLATE = Literal(HEADER),
+ TITLE = "Documentation and API reference")
+env.Depends(header, env.Value(repr(list(modules()))))
+
+footer = env.Command('doxy-footer.html', 'SConscript', writeTemplate,
+ TEMPLATE = Literal(FOOTER))
+
env.Alias('all_docs',
env.Command('search.php', [ 'html-munge.xsl', 'SConscript' ],
[ writeTemplate,
projects / senf.git / blobdiff