# -*- python -*-
-
-# Some internal information on how the documentation is generated. All
-# this is quite a mess, the complete documentation generation setup is
-# in dire need of a complete redesign, but ...
-#
#
# The documentation generation process is tightly integrated with the
# scons build framework:
# dependencies. This happens in the doxygen builder in
# senfscons/Doxygen.py.
#
-# * possibly the doclib/doxy-header.html and/or
-# doclib/doxy-footer.html files are regenerated
+# * 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.
#
-# * When building the complete documentation ('all_docs'), the
-# cross-reference page will be rebuilt if necessary (The global list
-# of 'Open Issues').
-#
-# * To fix some link errors, the additional 'linlint' and 'fixlinks'
+# * 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 within them. It understands @INCLUDE
-# directives and will find all the dependencies of the documentation:
+# 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.
# 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/.
#
# 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 tree
-# parts
+# 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
-#
-# * Additional processing added by the SENFSCons.Doxygen helper.
+# * The processing done by the Doxygen builder and doclib/doxygen.sh
#
#
# 3.1. Building prerequisites
#
# 3.2. The main doxygen build (Doxygen builder)
#
-# * doxygen proper is called
-#
-# * doxygen is configured in Doxyfile.global to call
-# 'doclib/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 ...)
-#
-# * doxygen is configured in Doxyfile.global to call 'doclib/dot' to
-# generate the 'dot' images.
+# The Doxygen builder will call the doxygen command to build the
+# documentation.
#
-# * 'doclib/dot' calls 'doclib/dot-munge.pl' on the .dot
-# files. dot-munge.pl changes the font and font-size and adds
-# line-breaks to long labels
-#
-# * 'doclib/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 rang direction (top-bottom vs. left-right). Then the
-# image with the smaller width is selected and returned.
-#
-# * after doxygen is finished, the list of referenced tag-files is
-# checked. For each tag file the directory is found, where the
-# documentation is generated (by scanning the Doxyfile which is
-# repsonsible for building the tag file). For every tag file, the
-# correct 'insstalldox' command is generated
-#
-# * The stamp files are created
+# The doxygen command is configured as 'doclib/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
#
-# 3.3. Postprocessing
+# * after doxygen is finished, 'installdox' is called to resolve
+# tag file references.
#
-# The following steps are mostly added to work around some stupid
-# doxygen problems
+# * the HTML documentation is post-processed using some sed, tidy, and
+# an XSLT template
#
-# * If a tag file is generated, 'senfscons/tagmunge.xsl' is called on the
-# tag file. This XSLT stylesheet removes all namespace components
-# from the tag file. Without this task, doxygen will completely barf
-# when two different documentation parts have members in the same
-# namespace.
+# * a generated tag file is post-processed using an XSLT template
#
-# * All html files are processed by 'doclib/html-munge.xsl'. However,
-# since the documentation generated by doxygen is completely broken
-# we need to preprocess the html files with a simple 'sed' script
-# and 'tidy' before 'xsltproc' even accepts the html code.
-#
-# * We use the generated xml output of doxygen to generate an XML
-# fragment for the global cross reference. This fragment is
-# generated by 'senfscons/xrefxtract.xslt'
+# (see doclib/doxygen.sh for more information). The Doxygen
+# configuration is set up such, that
#
+# * doxygen calls 'doclib/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
+# ...)
+#
+# * doxygen calls 'doclib/dot' to generate the 'dot' images.
#
-# 4. Building the global cross-reference
+# * 'doclib/dot' calls 'doclib/dot-munge.pl' on the .dot
+# files. dot-munge.pl changes the font and font-size and adds
+# line-breaks to long labels
#
-# The global cross reference is built from the cross-refernce
-# fragments generated for each of the documentation parts and from the
-# doxy-header.html/doxy-footer.html files. This conversion is
-# controlled by the 'senfscons/xrefhtml.xslt' stylesheet.
+# * 'doclib/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.
#
#
-# 5. Fixing broken links
+# 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
Import('env')
-import SENFSCons
+import SENFSCons, datetime, os
###########################################################################
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' ])
</div>
<div id="subtitle">
<ul>
- <li><a href="@TOPDIR@/doc/html/xref.html">Open Issues</a></li>
- <li><a class="ext" href="http://developer.berlios.de/bugs/?group_id=7489">Bug Tracker</a></li>
- <li><a class="ext" href="http://svn.berlios.de/viewcvs/senf/trunk/">Browse SVN</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://developer.berlios.de/projects/senf">BerliOS</a></li>
- <li><a class="ext" href="http://openfacts.berlios.de/index-en.phtml?title=SENF+Network+Framework">Wiki</a></li>
<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/viewcvs/senf/trunk/">Browse SVN</a></li>
+ <li><a class="ext" href="http://developer.berlios.de/bugs/?group_id=7489">Bug Tracker</a></li>
</ul>
- <h2>${TITLE}</h2>
</div>
</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.Append( ENV = {
+ 'TODAY' : str(datetime.date.today()),
+ 'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'),
+ 'DOXYGEN' : env.get('DOXYGEN', 'doxygen'),
+})
+
+env.Replace(
+ ALL_TAGFILES = [],
+ DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE",
+)
+
+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,