# -*- python -*-
+#
+# The documentation generation process is tightly integrated with the
+# scons build framework:
+#
+# * SCons analyzes the Doxyfile's to find all the documentation
+# dependencies. This happens in the doxygen builder in
+# senfscons/Doxygen.py.
+#
+# * the doclib/doxy-header.html and/or doclib/doxy-footer.html files
+# are regenerated
+#
+# * If any documentation is out-of-date with respect to it's source
+# files, the documentation is regenerated.
+#
+# * To fix some link errors, the additional 'linklint' and 'fixlinks'
+# targets are used
+#
+#
+# 1. Scanning the Doxyfile's
+#
+# The doxygen builder scans all documentation source files which have
+# the text 'doxyfile' in any case in their name. It understands
+# @INCLUDE directives and will find all the dependencies of the
+# documentation:
+#
+# * All the source files as selected by INPUT, INPUT_PATTERN,
+# RECURSIVE and so on.
+#
+# * Any referenced tag-files
+#
+# * Documentation header and/or footer
+#
+# * The INPUT_FILTER program
+#
+# * Any included doxygen configuration files
+#
+#
+# 2. Regenerating header and/or footer
+#
+# If needed, the doxy-header.html and/or doxy-footer.html file will be
+# regenerated. The header and/or footer are generated from templates
+# using a simple python based templating system called yaptu which is
+# included in site_scons/lib/.
+#
+#
+# 3. Calling doxygen
+#
+# The doxygen call itself is quite complex since there is some pre-
+# and post-processing going on. We can separate this step into two
+# steps
+#
+# * Building prerequisites (e.g. images)
+#
+# * The processing done by the Doxygen builder and
+# site_scon/lib/doxygen.sh
+#
+#
+# 3.1. Building prerequisites
+#
+# The prerequisites are images referenced by the documentation. These
+# images are mostly generated using the Dia2Png builder.
+#
+#
+# 3.2. The main doxygen build (Doxygen builder)
+#
+# The Doxygen builder will call the doxygen command to build the
+# documentation.
+#
+# The doxygen command is configured as 'site_scon/lib/doxygen.sh' which
+# does some additional processing in addition to calling doxygen
+# proper
+#
+# * it sets environment variables depending on command line arguments.
+# These variables are then used in the Doxyfile's
+#
+# * after doxygen is finished, 'installdox' is called to resolve
+# tag file references.
+#
+# * the HTML documentation is post-processed using some sed, tidy, and
+# an XSLT template
+#
+# * a generated tag file is post-processed using an XSLT template
+#
+# (see site_scon/lib/doxygen.sh for more information). The Doxygen
+# configuration is set up such, that
+#
+# * doxygen calls 'site_scons/lib/filter.pl' on each source file. This
+# filter will strip excess whitespace from the beginning of lines in
+# '\code' and '<pre>' blocks. Additionally it will expand all tabs,
+# tab width is 8 spaces (there should be no tabs in the source but
+# ...)
+#
+# * 'site_scons/lib/filter.pl' calls 'site_scons/lib/makeDiaImageMap.py'
+# whenever finding a '\diaimage' command. This will create an image
+# map (in an encoded form which will be fixed by html-munge.xsl
+# later)
+#
+# * doxygen calls 'site_scons/lib/dot' to generate the 'dot' images.
+#
+# * 'site_scons/lib/dot' calls 'site_scons/lib/dot-munge.pl' on the
+# .dot files. dot-munge.pl changes the font and font-size and adds
+# line-breaks to long labels
+#
+# * 'site_scons/lib/dot' calls the real dot binary. If the resulting
+# image is more than 800 pixels wide, dot is called again, this time
+# using the oposite rank direction (top-bottom vs. left-right). The
+# image with the smaller width is selected and returned.
+#
+#
+# 4. Fixing broken links
+#
+# After the documentation has been generated, additional calls first
+# to the 'linklint' and then to the 'fixlinks' target will try to fix
+# broken links generated by doxygen. First, 'linklint' will call the
+# linklint tool to check for broken links in the documentation.
+#
+# 'fixlinks' is then called which calls 'doclib/fixlinks.py' which
+# scans *all* html files, builds an index of all (unique) anchors and
+# then fixes the url part of all links with correct anchor but bad
+# file name.
+#
+
Import('env')
-import SENFSCons
+import SENFSCons, datetime, os
###########################################################################
import yaptu
def modules():
+ # Naja ... etwas rumgehackt aber was solls ...
global EXTRA_MODULES
- rv = []
- ix = len(env.Dir('#').abspath)+1
- ex = dict((env.Dir(p).abspath,True) for n,p in EXTRA_MODULES)
+ mods = {}
+ pathbase = env.Dir('#/senf').abspath
+ pathbasel = len(pathbase)+1
for module in env.Alias('all_docs')[0].sources:
- if module.name != 'html.stamp' : continue
- if not ex.get(module.dir.abspath):
- rv.append(('lib%s' % module.dir.dir.dir.name, module.dir.abspath[ix:]))
- rv.sort()
- return [ (name, env.Dir(path).abspath[ix:]) for name,path in EXTRA_MODULES ] + rv
+ if module.name != 'html.stamp' : continue
+ 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 = []
+ keys = mods.keys()
+ keys.sort()
+ for mod in keys:
+ i = 0
+ while i < len(rv):
+ 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][-1] = level
+ break
+ i += 1
+ if i == len(rv):
+ rv.append(mod)
+
+ return ( tuple(mods[mod]) for mod in rv )
def indices():
ix = len(env.Dir('#').abspath)+1
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'),
- ('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>
<title>$title</title>
<link href="@TOPDIR@/doc/html/doxygen.css" rel="stylesheet" type="text/css">
<link href="@TOPDIR@/doclib/senf.css" rel="stylesheet" type="text/css">
+<link rel="shortcut icon" href="@TOPDIR@/doclib/favicon.ico">
<style type="text/css">
-div.tabs ul li.$projectname a { background-color: #EDE497; }
+div.tabs li.$projectname a { background-color: #EDE497; }
</style>
</head>
<body>
<div id="head">
- <div id="search">
- <form action="@TOPDIR@/doclib/search.php" method="get">
- Search: <input type="text" name="query" size="20" accesskey="s"/>
- </form>
+ <div id="title">
+ <div id="title2">
+ <div id="search">
+ <form action="@TOPDIR@/doclib/search.php" method="get">
+ Search: <input type="text" name="query" size="20" accesskey="s"/>
+ </form>
+ </div>
+ <h1>SENF Extensible Network Framework</h1>
+ </div>
+ </div>
+ <div id="subtitle">
+ <ul>
+ <li><a href="@TOPDIR@/doc/html/index.html">Home</a></li>
+ <li><a class="ext" href="http://satext.fokus.fraunhofer.de/senf/debian">Download</a></li>
+ <li><a class="ext" href="http://openfacts2.berlios.de/wikien/index.php/BerliosProject:SENF_Network_Framework">Wiki</a></li>
+ <li><a class="ext" href="http://developer.berlios.de/projects/senf">BerliOS</a></li>
+ <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/wsvn/senf/trunk/">Browse SVN</a></li>
+ <li><a class="ext" href="http://developer.berlios.de/bugs/?group_id=7489">Bug Tracker</a></li>
+ </ul>
</div>
- <h1>SENF Extensible Network Framework</h1>
- <h2>${TITLE}</h2>
</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 in modules():
- <li class="${name}"><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>
}}
</ul>
</div>"""
-OVERVIEW_EXTRA_HEADER="""
- <div class="tabs">
- <ul>
- <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
- <li><a class="ext" href="http://svn.berlios.de/wsvn/senf/?op=log&rev=0&sc=0&isdir=1">SVN ChangeLog</a></li>
- <li><a class="ext" href="http://developer.berlios.de/projects/senf">SENF @ BerliOS</a></li>
- <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
- </ul>
- </div>"""
-
FOOTER = """<hr style="width:0px;border:none;clear:both;margin:0;padding:0" />
</div>
</div>
<div id="footer">
<span>
<a href="mailto:senf-dev@lists.berlios.de">Contact: senf-dev@lists.berlios.de</a> |
- Copyright © 2006 Fraunhofer Gesellschaft, SatCom, Stefan Bund
+ © 2006-2010 <a href="http://www.fokus.fraunhofer.de/en/net/index.html">
+ Fraunhofer Institute for Open Communication Systems, Network Research</a>
</span>
</div>
</body></html>"""
}
?>"""
-env.Command('doxy-header.html', None, writeTemplate,
- TEMPLATE = Literal(HEADER),
- TITLE = "Documentation and API reference")
-env.Command('doxy-header-overview.html', None, writeTemplate,
- TEMPLATE = Literal(HEADER+OVERVIEW_EXTRA_HEADER),
- TITLE = "Introduction and Overview")
-env.Command('doxy-footer.html', None, writeTemplate,
- TEMPLATE = Literal(FOOTER))
+env.SetDefault(
+ DOXYGEN = "doxygen"
+)
+
+env.Append( ENV = {
+ 'TODAY' : str(datetime.date.today()),
+})
+
+env.PhonyTarget('linklint', [], [
+ 'rm -rf doc/linklint',
+ 'linklint -doc doc/linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
+])
+
+env.PhonyTarget('fixlinks', [], [
+ 'python doclib/fix-links.py -v -s .svn -s linklint -s debian -s doclib -s search',
+])
+
+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',
+ env.Command('search.php', [ '#/site_scons/lib/html-munge.xsl', 'SConscript' ],
[ writeTemplate,
'xsltproc --nonet --html --stringparam topdir .. -o - $SOURCE $TARGET 2>/dev/null'
+ "| sed"
+ r" -e 's/\[\[/<?/g' -e 's/\]\]/?>/g'"
+ r" -e 's/\$$projectname/Overview/g'"
+ r" -e 's/\$$title/Search results/g'"
- + "> ${TARGET}.tmp",
+ + "> ${TARGETS[0]}.tmp",
'mv ${TARGET}.tmp ${TARGET}' ],
TEMPLATE = Literal(HEADER
- + OVERVIEW_EXTRA_HEADER
+ SEARCH_PHP.replace('<?','[[').replace('?>',']]')
+ FOOTER),
TITLE = "Search results"))
env.Alias('all_docs',
- env.Command('search_paths.php', None, writeTemplate,
+ env.Command('search_paths.php', 'SConscript', writeTemplate,
TEMPLATE = Literal(SEARCH_PATHS_PHP)))
+
+env.Alias('install_all',
+ env.Install( '$DOCINSTALLDIR/doclib', [ 'favicon.ico',
+ 'logo-head.png',
+ 'search.php',
+ 'search_functions.php',
+ 'search_paths.php',
+ 'senf.css' ] ))
+
+env.Clean('all', 'doxy-header.html') # I should not need this but I do ...
+env.Clean('all_docs', 'doxy-header.html') # I should not need this but I do ...
+
+env.Install('${DOCINSTALLDIR}', 'index.html')
+
+env.Depends(SENFSCons.Doxygen(env, output_directory="../doc"), env.Value(env['ENV']['REVISION']))
projects / senf.git / blobdiff