| Home | Trees | Index | Help |  | 
|---|
| Package epydoc :: Module latex :: Class LatexFormatter | 
 | 
LatexFormatter consists of a single LaTeX document, divided 
into several different files. In particular, LatexFormatter 
generates the following files:
latex on.
  sys or epydoc.epytext.
  epydoc.epytext.Token or 
    array.ArrayType. These class documentation files are 
    only created if the list_classes_separately option is 
    used; otherwise, the documentation for each class is included in its 
    module's documentation file.
  write_module and write_class 
used to generate individual module and class documentation LaTeX files. 
These files can then be included as chapters or sections of other LaTeX 
documents (with "\include"). When using these 
methods, you may wish to disable the crossref option, which 
will turn off crossreferencing betweeen modules and classes, since some 
of these crossreference links will be broken if you only include some of 
the API documentation as chapters or sections of your document.
| Method Summary | |
|---|---|
| Construct a new LaTeX formatter, using the given documentation map. | |
| int | Return the number of files that this LatexFormatterwill 
generate. | 
| None | Write the API documentation for the entire project to the given directory. | 
| Write the API documentation for the given class to filename. | |
| Write the API documentation for the given module to filename. | |
| _base_tree(self,
          uid,
          width,
          linespec) | |
| _base_tree_line(self,
          uid,
          width,
          linespec) | |
| _class_list(self,
          container,
          classes) | |
| _class_list_line(self,
          link) | |
| _class_to_latex(self,
          uid) | |
| int | Compare uid1 and uid2 by their names, using the following rules: | 
| _descrlist(self,
          items,
          singular,
          plural,
          short) | |
| _docstring_to_latex(self,
          docstring,
          indent,
          breakany) | |
| Return true if the given object should be excluded from the documentation (since it was imported or inherited from a module that we're not documenting). | |
| listofLink | Filter a list of Links. | 
| _find_tree_width(self,
          uid) | |
| _func_list(self,
          container,
          functions,
          heading,
          seclevel) | |
| _func_list_box(self,
          link,
          cls) | |
| _func_signature(self,
          fname,
          fdoc,
          show_defaults) | |
| _header(self,
          where) | |
| _indexterm(self,
          uid,
          pos) | |
| _inheritance_list(self,
          links,
          cls) | |
| _inheritance_list_line(self,
          links,
          cls) | |
| boolean | Return true if stris the name of a private Python object. | 
| _kind(self,
          uid) | |
| string | Return the HTML code for the module hierarchy tree, containing the given modules. | 
| _module_to_latex(self,
          uid) | |
| string | Return the HTML code for the module hierarchy tree. | 
| string | Helper function for _module_treeand_module_list. | 
| _params_to_latex(self,
          parameters,
          show_defaults) | |
| _pprint_var_value(self,
          var,
          maxwidth) | |
| _property_list(self,
          container,
          properties,
          heading,
          seclevel) | |
| _property_list_line(self,
          link,
          container) | |
| _section(self,
          title,
          depth) | |
| _sectionstar(self,
          title,
          depth) | |
| string | Return hTML code containing descriptions of the epytext fields that are common to all ObjDocs (except fordescr). | 
| _start_of(self,
          section_name) | |
| Return the LaTeX code for the subclasses field. | |
| string | Return the LATEX code for the summary description of the object documented by doc. | 
|  | |
| _topfile(self) | |
| _uid_to_label(self,
          uid) | |
| _var_list(self,
          container,
          variables,
          heading,
          seclevel) | |
| _var_list_line(self,
          var,
          container) | |
| Instance Variable Summary | |
|---|---|
| _docmap: The documentation map, encoding the objects that should be 
documented. | |
| _show_private: Whether to include show private objects in the documentation. | |
| Class Variable Summary | |
|---|---|
| _LatexDocstringLinker | _docstring_linker=<epydoc.latex._LatexDocstringLinker ... | 
| Method Details | 
|---|
| __init__(self,
          docmap,
          **kwargs)
    Construct a new LaTeX formatter, using the given documentation 
  map. | 
| num_files(self)
 | 
| write(self, directory=None, progress_callback=None)Write the API documentation for the entire project to the given directory.
 | 
| write_class(self, uid, filename)Write the API documentation for the given class tofilename.
 | 
| write_module(self, uid, filename)Write the API documentation for the given module tofilename.
 | 
| _cmp_name(self, name1, name2)Compare uid1 and uid2 by their names, using the following rules:
 
 | 
| _excluded(self, x)
 | 
| _filter(self, links)Filter a list ofLinks. If_show_privateis false, then filter out 
  all private objects; otherwise, perform no filtering. | 
| _is_private(self, str)
 | 
| _module_list(self, container, modules)
 | 
| _module_tree(self, sortorder=None)
 | 
| _module_tree_item(self, uid=None, depth=0)Helper function for_module_treeand_module_list.
 | 
| _standard_fields(self, doc)
 | 
| _subclasses(self, subclasses, container)
 | 
| _summary(self, doc, container=None)
 | 
| _text_to_latex(self, str, nbsp=0, breakany=0)
 | 
| Instance Variable Details | 
|---|
| _docmapThe documentation map, encoding the objects that should be documented. | 
| _show_privateWhether to include show private objects in the documentation. | 
| Class Variable Details | 
|---|
| _docstring_linker
 | 
| Home | Trees | Index | Help |  | 
|---|
| Generated by Epydoc 2.1 on Sat Mar 20 17:46:19 2004 | http://epydoc.sf.net |