X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=doclib%2FSConscript;h=78312004de28d0b119edc19c9b62c4006ae6f86c;hb=25976ed67c66d30811fa0a01043e50347e9d1e69;hp=ab5a009d0279dc55a60efacaf84f0b4c62626768;hpb=7746a408cc69f62722ce87c35dab1cabe03d7626;p=senf.git diff --git a/doclib/SConscript b/doclib/SConscript index ab5a009..7831200 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -39,11 +39,7 @@ # 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/. # @@ -121,7 +117,7 @@ Import('env') -import SENFSCons +import SENFSCons, datetime, os ########################################################################### @@ -131,11 +127,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 = [] @@ -144,39 +143,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(): @@ -186,20 +164,15 @@ 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 = """ @@ -233,7 +206,6 @@ div.tabs li.$projectname a { background-color: #EDE497; }
  • ChangeLog
  • Browse SVN
  • Bug Tracker
    • -
  • Open Issues
    • @@ -241,11 +213,16 @@ div.tabs li.$projectname a { background-color: #EDE497; }
    +
  • Overview
    • +
  • Examples
    • +
  • HowTos
    • +
  • Glossary
    • +
    +
      -{{ for name, path, level in modules(): -
    • ${name}
      • +{{ for id, name, path, level in modules(): +
    • ${name}
      • }} -
    • Glossary
    """ @@ -274,11 +251,43 @@ function paths() { } ?>""" -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' : 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.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('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, @@ -307,3 +316,5 @@ 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')