X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=doclib%2FSConscript;h=39280f57a9093b97cde21daa2cf7939f37d13deb;hb=309d78606f59617de0cfb1469b22111c846891ad;hp=696fc27891d0b361ef33e85ac323fc51b64aa09d;hpb=86b3d95df28c60c80ac852dc8356d814788366a7;p=senf.git diff --git a/doclib/SConscript b/doclib/SConscript index 696fc27..39280f5 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -41,7 +41,7 @@ # 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 @@ -52,7 +52,8 @@ # # * 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 @@ -66,7 +67,7 @@ # 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 # @@ -81,25 +82,30 @@ # # * 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 '
' 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 @@ -127,11 +133,14 @@ def modules(): # 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 = [] @@ -140,39 +149,18 @@ def modules(): 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(): @@ -191,14 +179,6 @@ 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 = """ @@ -239,11 +219,16 @@ div.tabs li.$projectname a { background-color: #EDE497; }+ """ @@ -272,34 +257,28 @@ function paths() { } ?>""" +env.SetDefault( + DOXYGEN = "doxygen" +) + env.Append( ENV = { 'TODAY' : str(datetime.date.today()), - 'TEXINPUTS' : os.environ.get('TEXINPUTS',env.Dir('#/doclib').abspath + ':'), - 'DOXYGEN' : env.get('DOXYGEN', 'doxygen'), + 'DOXYGEN' : str(env.File(env['DOXYGEN'])), }) -env.Replace( - ALL_TAGFILES = [], - DOXYGENCOM = "doclib/doxygen.sh $DOXYOPTS $SOURCE", -) - -SENFSCons.PhonyTarget(env, 'linklint', [ - 'rm -rf linklint', - 'linklint -doc linklint -limit 99999999 `find -type d -name html -printf "/%P/@ "`', - '[ ! -r linklint/errorX.html ] || python doclib/linklint_addnames.pylinklint/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.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('linklint', [], [ + '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.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.new', + '[ ! -r doc/linklint/errorAX.html.new ] || mv doc/linklint/errorAX.html.new doc/linklint/errorAX.html', ]) -env.Clean('all', env.Dir('linklint')) - -SENFSCons.PhonyTarget(env, 'fixlinks', [ - 'python doclib/fix-links.py -v -s .svn -s linklint -s debian linklint/errorX.txt linklint/errorAX.txt', +env.PhonyTarget('fixlinks', [], [ + '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") @@ -309,7 +288,7 @@ footer = env.Command('doxy-footer.html', 'SConscript', writeTemplate, 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" @@ -336,3 +315,7 @@ env.Alias('install_all', 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']))