html.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/>.

##
# 
# @package html
# Provide one builder, HTML, to generate a website from a LaTeX 
# document.
# 
# @page pg_docblds Document reproducible research
# 
# @section sec_htmlbld HTML
# 
# Defined in the html tool. Builder to generate a website from a LaTeX 
# document.
# 

from SCons.Script import Action, Dir, Mkdir
from os.path import splitext
from SCons.Scanner import Scanner
from repro.scanners.latexgraphics import scanner_function
from repro.DefaultL2Hfiles import l2hdefault_init, l2hdefault_style
from repro.functions.SourceToHtml import PyHtmlAction

##
# 
#     @brief Alias target(s) of HTML to 'scons html' and build default 
#     LaTeX2html initialization file.
#     
def html_emitter( target, source, env ):
        
    html_folder    = splitext(str(target[0]))[0]
    l2h_init_fname = 'l2h_init-'+html_folder
    env.Clean( target, [html_folder, l2h_init_fname] )

    env.Alias( 'html',target)

    return (target + [l2h_init_fname], source)

##
# 
#     @brief Create basic style sheet for LaTeX2html and add HTML builder 
#     to the environment.
#     
def generate(env):
    
    env['debug']          =  False
    env['_debug']         = "${debug and '-debug' or ' '}"
    env['LATEX2HTMLOPTS'] = "$_debug"
    
    html_actions = [Action(l2hdefault_init),
                   Mkdir('${TARGET.filebase}'),
                   Action('latex2html $LATEX2HTMLOPTS -dir ${TARGET.filebase} '\
                          '${SOURCE.abspath} -init_file l2h_init-${TARGET.filebase}'),
                   Action(l2hdefault_style),
                   ]
    
    html_builder = env.Builder( action=html_actions,
                                src_suffix='.ltx',
                                emitter=html_emitter,
                                target_factory=Dir,
                                source_scanner=Scanner( scanner_function )
                                )

    env["BUILDERS"]['HTML'] = html_builder
    
    
    py_html_bldr = env.Builder( action=PyHtmlAction,
                                suffix='.html',
                                src_suffix='.py')

    env["BUILDERS"]['ColorPySource'] = py_html_bldr

##
# 
#     @brief Return True (this tool always exists).
#     
def exists( env ):
    return 1 

---