# 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 doclib/.
+# included in site_scons/lib/.
#
#
# 3. Calling doxygen
#
# * Building prerequisites (e.g. images)
#
-# * The processing done by the Doxygen builder and doclib/doxygen.sh
+# * The processing done by the Doxygen builder and
+# site_scon/lib/doxygen.sh
#
#
# 3.1. Building prerequisites
# The Doxygen builder will call the doxygen command to build the
# documentation.
#
-# The doxygen command is configured as 'doclib/doxygen.sh' which
+# The doxygen command is configured as 'site_scon/lib/doxygen.sh' which
# does some additional processing in addition to calling doxygen
# proper
#
#
# * a generated tag file is post-processed using an XSLT template
#
-# (see doclib/doxygen.sh for more information). The Doxygen
+# (see site_scon/lib/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
+# * 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
# ...)
-#
-# * doxygen calls 'doclib/dot' to generate the 'dot' images.
#
-# * 'doclib/dot' calls 'doclib/dot-munge.pl' on the .dot
-# files. dot-munge.pl changes the font and font-size and adds
+# * '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
#
-# * '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.
+# * '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
<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>"""
DOXYGEN = "doxygen"
)
-env.Replace(
- DOXYGENCOM = "site_scons/lib/doxygen.sh $DOXYOPTS $SOURCE",
-)
-
env.Append( ENV = {
'TODAY' : str(datetime.date.today()),
- 'DOXYGEN' : str(env.File(env['DOXYGEN'])),
})
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"',
+ 'rm -rf doc/linklint',
+ 'linklint -doc doc/linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`',
+ '[ ! -r doc/linklint/errorX.html ] || python doclib/linklint_addnames.py <doc/linklint/errorX.html >doc/linklint/errorX.html.new',
+ '[ ! -r doc/linklint/errorX.html.new ] || mv doc/linklint/errorX.html.new doc/linklint/errorX.html',
+ '[ ! -r doc/linklint/errorAX.html ] || python doclib/linklint_addnames.py <doc/linklint/errorAX.html >doc/linklint/errorAX.html.new',
+ '[ ! -r doc/linklint/errorAX.html.new ] || mv doc/linklint/errorAX.html.new doc/linklint/errorAX.html',
])
env.PhonyTarget('fixlinks', [], [
- 'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt',
+ 'python doclib/fix-links.py -v -s .svn -s linklint -s debian doc/linklint/errorX.txt doc/linklint/errorAX.txt',
])
-
header = env.Command('doxy-header.html', 'SConscript', writeTemplate,
TEMPLATE = Literal(HEADER),
TITLE = "Documentation and API reference")
TEMPLATE = Literal(FOOTER))
env.Alias('all_docs',
- env.Command('search.php', [ 'html-munge.xsl', 'SConscript' ],
+ env.Command('search.php', [ '#/site_scons/lib/html-munge.xsl', 'SConscript' ],
[ writeTemplate,
'xsltproc --nonet --html --stringparam topdir .. -o - $SOURCE $TARGET 2>/dev/null'
+ "| sed"
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