Book.py

Go to the documentation of this file.

#  This file is part of repro, a Python package for automating 
#  reproducible research in scientific computing.
#
#  Copyright (C) 2008  Gilles Hennenfent, Sean Ross-Ross
#
#  This program is free software: you can redistribute it and/or modify
#  it under the terms of the GNU General Public License as published by
#  the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  This program is distributed in the hope that it will be useful,
#  but WITHOUT ANY WARRANTY; without even the implied warranty of
#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#  GNU General Public License for more details.
#
#  You should have received a copy of the GNU General Public License
#  along with this program.  If not, see <http://www.gnu.org/licenses/>.

from os.path import join,abspath
from repro.BookKeeping import ReproProject
 
##
# 
#     @todo Documentation
#     
def BookAction( target, source, env ):

    allbooks = set()
    used_ins = ReproProject.used_ins
    
    uses = {}
    
    for key, value in used_ins.iteritems():
        for book in value:
            uu = uses.setdefault(book,[])
            uu.append(key)
    
    [ allbooks.update(value) for value in used_ins.itervalues() ]
    
    doxy = open( str(target[0]), 'w' )
    
    print >> doxy, "// repro"
    print >> doxy, "// This File is automatically generated"
    print >> doxy
    
    print >> doxy, "// Creating placeholder references for book pages in case they do not exists"
    print >> doxy, "/*!"
    print >> doxy, "@page sbooks"
    
    for book in allbooks:
        book_ref = book.replace('/','_')
        print >> doxy, " @arg @subpage %(book_ref)s" %vars()
    print >> doxy
    for book in allbooks:
        book_ref = book.replace('/','_')
        print >> doxy, "@page %(book_ref)s %(book)s" %vars()
        print >> doxy, "  @section sbuses Uses"
        for uu in uses[book]:
            print >> doxy, "    @arg @ref %(uu)s" %vars() 
        
    print >> doxy, "*/"
    print >> doxy
    
    print >> doxy, "// Creating 'USED IN': sections for all main programs"
    print >> doxy, "/*!"
    for key, value in used_ins.iteritems():
        print >> doxy
        print >> doxy, "@page %(key)s" %vars()
        print >> doxy, "  @section used_ins Used In: "
        for book in value:
            book_ref = book.replace('/','_')
            print >> doxy, "    @arg @ref %(book_ref)s" %vars( )
    
    print >> doxy, "*/"
    pass


##
# 
#     @todo Alias target(s) of Book builder to 'scons book' command. 
#     
def book_emitter( target, source, env ):

    env.Alias( 'book', target )
    
    return target, source
    pass

---