Home       Trees       Index       Help   

epydoc 3.0alpha2

Package epydoc :: Package docwriter :: Module latex :: Class LatexWriter
[hide private]
[frames] | no frames]

Class LatexWriter
source code

Nested Classes [hide private]
_LatexDocstringLinker  

Instance Methods [hide private]
  __init__(self, docindex, **kwargs)
None write(self, directory=None)
Write the API documentation for the entire project to the given directory.
  _write(self, write_func, directory, filename, *args)
int num_files(self)
None _mkdir(self, directory)
If the given directory does not exist, then attempt to create it.
  write_topfile(self, out)
  write_preamble(self, out)
  write_module(self, out, doc)
  write_class(self, out, doc)
  write_module_tree(self, out)
  write_module_list(self, out, doc)
string write_module_tree_item(self, out, doc, depth=0)
Helper function for _module_tree and _module_list.
  base_tree(self, doc, width=None, linespec=None)
  _find_tree_width(self, doc)
  _base_tree_line(self, doc, width, linespec)
  write_class_list(self, out, doc)
  write_class_list_line(self, out, var_doc)
  write_func_list(self, out, heading, doc, value_type, seclevel=1)
  write_func_list_box(self, out, var_doc)
  function_signature(self, var_doc)
  func_arg(self, name, default)
  _arg_name(self, arg)
  write_var_list(self, out, heading, doc, value_type, seclevel=1)
  write_var_list_line(self, out, var_doc)
  _pprint_var_value(self, s, maxwidth=100)
  write_property_list_line(self, out, var_doc)
  write_standard_fields(self, out, doc)
  write_standard_field(self, out, doc, field, descrs, arg='')
  _descrlist(self, items, singular, plural=None, short=0)
  docstring_to_latex(self, docstring, indent=0, breakany=0)
  write_header(self, out, where)
  write_start_of(self, out, section_name)
  section(self, title, depth=0)
  sectionstar(self, title, depth)
  doc_kind(self, doc)
  indexterm(self, doc, pos='only')
Mark a term or section for inclusion in the index.
  label(self, doc)

Class Variables [hide private]
PREAMBLE  
HRULE  
SECTIONS  
STAR_SECTIONS  
_docstring_linker  

Method Details [hide private]

__init__(self, docindex, **kwargs)
(Constructor)

source code 

write(self, directory=None)

source code 
Write the API documentation for the entire project to the given directory.
Parameters:
  • directory (string) - The directory to which output should be written. If no directory is specified, output will be written to the current directory. If the directory does not exist, it will be created.
Returns: None
Raises:
  • OSError - If directory cannot be created,
  • OSError - If any file cannot be created or written to.

_write(self, write_func, directory, filename, *args)

source code 

num_files(self)

source code 
Returns: int
The number of files that this LatexFormatter will generate.

_mkdir(self, directory)

source code 
If the given directory does not exist, then attempt to create it.
Returns: None

write_topfile(self, out)

source code 

write_preamble(self, out)

source code 

write_module(self, out, doc)

source code 

write_class(self, out, doc)

source code 

write_module_tree(self, out)

source code 

write_module_list(self, out, doc)

source code 

write_module_tree_item(self, out, doc, depth=0)

source code 
Helper function for _module_tree and _module_list.
Returns: string

base_tree(self, doc, width=None, linespec=None)

source code 

_find_tree_width(self, doc)

source code 

_base_tree_line(self, doc, width, linespec)

source code 

write_class_list(self, out, doc)

source code 

write_class_list_line(self, out, var_doc)

source code 

write_func_list(self, out, heading, doc, value_type, seclevel=1)

source code 

write_func_list_box(self, out, var_doc)

source code 

function_signature(self, var_doc)

source code 

func_arg(self, name, default)

source code 

_arg_name(self, arg)

source code 

write_var_list(self, out, heading, doc, value_type, seclevel=1)

source code 

write_var_list_line(self, out, var_doc)

source code 

_pprint_var_value(self, s, maxwidth=100)

source code 

write_property_list_line(self, out, var_doc)

source code 

write_standard_fields(self, out, doc)

source code 

write_standard_field(self, out, doc, field, descrs, arg='')

source code 

_descrlist(self, items, singular, plural=None, short=0)

source code 

docstring_to_latex(self, docstring, indent=0, breakany=0)

source code 

write_header(self, out, where)

source code 

write_start_of(self, out, section_name)

source code 

section(self, title, depth=0)

source code 

sectionstar(self, title, depth)

source code 

doc_kind(self, doc)

source code 

indexterm(self, doc, pos='only')

source code 
Mark a term or section for inclusion in the index.

label(self, doc)

source code 

Class Variable Details [hide private]

PREAMBLE

Value:
['\\documentclass{article}',
 '\\usepackage{alltt, parskip, fancyheadings, boxedminipage}',
 '\\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}',
 '\\usepackage{fullpage}',
 '\\setlength{\\headheight}{16pt}',
 '\\setlength{\\headsep}{24pt}',
 '\\setlength{\\topmargin}{-\\headsep}',
 '\\setlength{\\parindent}{0ex}',
...

HRULE

Value:
'''\\rule{\\textwidth}{0.5\\fboxrule}

'''

SECTIONS

Value:
['\\part{%s}',
 '\\chapter{%s}',
 '\\section{%s}',
 '\\subsection{%s}',
 '\\subsubsection{%s}',
 '\\textbf{%s}']

STAR_SECTIONS

Value:
['\\part*{%s}',
 '\\chapter*{%s}',
 '\\section*{%s}',
 '\\subsection*{%s}',
 '\\subsubsection*{%s}',
 '\\textbf{%s}']

_docstring_linker

Value:
<epydoc.docwriter.latex._LatexDocstringLinker instance at 0x41333cec>

   Home       Trees       Index       Help   

epydoc 3.0alpha2

Generated by Epydoc 3.0alpha2 on Tue Apr 11 17:35:12 2006 http://epydoc.sf.net