Contents   Class: FormatterLaTeX
<<Method: FormatterLaTeX.write_single_module_header<<   >>Method: FormatterLaTeX.write_vars>>

Method: FormatterLaTeX.__init__

Synopsis: __init__( self, listofmodules, output_dir='.', output_type='TEX', latex_preamble='' )

Initialize m_dest with an output file object to be used as destination for all output. Argument latex_preamble can be used to provide some additional LaTeX statements for the preamble of the resulting document. Argument listofmodules is the list comprising the names of the modules to be documented. This is for instance used to produce an initial implementation of the macro printtitle for the titlepage and for page headers and footers. listofmodules is also used to generate a filename:

Parameter output_dir specifies the directory where to save the desired output.

Parameter output_type specifies the target of the operation and may be either 'TEX', 'DVI', or 'PDF'. In the latter case, method close( ) will try to start latex or pdflatex in order to produce a document of the demanded kind. If this production fails, at least the produced LaTeX source is copied to output_dir . The programs latex or pdflatex resp. are assumed to be in the path of executable programs.



Elements:

none

 

Generated by pymanual (c) 2005-2006 on August 02, 2006.