X-Git-Url: http://g0dil.de/git?a=blobdiff_plain;f=doclib%2FSConscript;h=94dcdc911101c597a8318bcc40cd27c28906fbe4;hb=a1fdb7bb122f0b05be809a922d4b7ef5e125fa67;hp=3a8e265d847c400556d58a02730abf5cd7bf9bb6;hpb=a4887e674af3fce4180cf7e14bedace928962025;p=senf.git diff --git a/doclib/SConscript b/doclib/SConscript index 3a8e265..94dcdc9 100644 --- a/doclib/SConscript +++ b/doclib/SConscript @@ -1,5 +1,155 @@ # -*- 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: +# +# * SCons analyzes the Doxyfile's to find all the documentation +# 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 +# +# * 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' +# 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 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 +# 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 +# +# * Building prerequisites (e.g. images) +# +# * The processing done by the Doxygen builder +# +# * Additional processing added by the SENFSCons.Doxygen helper. +# +# +# 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) +# +# * 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 +# '
' 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.
+#
+# * '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 rank direction (top-bottom vs. left-right). 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 'installdox' command is generated.
+#
+# * The stamp files are created
+#
+#
+# 3.3. Postprocessing
+#
+# The following steps are mostly added to work around some stupid
+# doxygen problems
+#
+# * 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.
+#
+# * All html files are processed by 'doclib/html-munge.xsl'. However,
+#   since the documentation generated by doxygen is completely invalid
+#   html 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'
+#
+#
+# 4. Building the global cross-reference
+#
+# 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.
+#
+#
+# 5. 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
 
@@ -8,16 +158,56 @@ import SENFSCons
 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 = len(env.Dir('#').abspath)+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
+        mods[module.dir.dir.dir.abspath] = [ module.dir.dir.dir.name,
+                                             module.dir.abspath[pathbase:],
+                                             0 ]
+        
+    rv = []
+    keys = mods.keys()
+    keys.sort()
+    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
+                i += 1
+                while i < len(rv) and mods[rv[i]][2] >= level:
+                    i += 1
+                rv[i:i] = [ mod ]
+                mods[mod][2] = 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():
     ix = len(env.Dir('#').abspath)+1
@@ -37,7 +227,8 @@ writeTemplate = env.Action(writeTemplate, varlist = [ 'TEMPLATE' ])
 EXTRA_MODULES = [
     ('Overview', '#/doc/html'),
     ('Examples', '#/Examples/doc/html'),
-    ('SENFScons', '#/senfscons/doc/html') ]
+    ('HowTos', '#/HowTos/doc/html'),
+    ('SENFSCons', '#/senfscons/doc/html') ]
 
 HEADER = """
 
@@ -45,39 +236,46 @@ HEADER = """$title
 
 
+