Package epydoc :: Package docwriter :: Module latex :: Class LatexWriter

[hide private]
[frames] | no frames]

# Class LatexWriter

source code

Nested Classes | [hide private]

Docstring -> LaTeX Conversion
| _LatexDocstringLinker

Instance Methods | [hide private]

__init__(self, docindex, **kwargs) | source code

`None`

write(self, directory=None) Write the API documentation for the entire project to the given directory. | source code

_write(self, write_func, directory, filename, *args) | source code

`int`

num_files(self) Returns: The number of files that this `LatexFormatter` will generate. | source code

`None`

_mkdir(self, directory) If the given directory does not exist, then attempt to create it. | source code

Main Doc File

write_topfile(self, out) | source code

write_preamble(self, out) | source code

Chapters

write_module(self, out, doc) | source code

write_class(self, out, doc) | source code

Module hierarchy trees

write_module_tree(self, out) | source code

write_module_list(self, out, doc) | source code

`string`

write_module_tree_item(self, out, doc, depth=0) Helper function for write_module_tree and write_module_list. | source code

Base class trees

base_tree(self, doc, width=None, linespec=None) | source code

_base_name(self, doc) | source code

_find_tree_width(self, doc) | source code

_base_tree_line(self, doc, width, linespec) | source code

Class List

write_class_list(self, out, doc) | source code

write_class_list_line(self, out, var_doc) | source code

Function List

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

write_func_group(self, out, doc, name, var_docs, grouped_inh_vars) | source code

write_func_inheritance_list(self, out, doc, listed_inh_vars) | 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

Variable List

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

write_var_group(self, out, doc, name, var_docs, grouped_inh_vars) | source code

write_var_inheritance_list(self, out, doc, listed_inh_vars) | source code

write_var_list_line(self, out, var_doc) | source code

write_property_list_line(self, out, var_doc) | source code

Standard Fields

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 -> LaTeX Conversion

docstring_to_latex(self, docstring, indent=0, breakany=0) | source code

Helpers

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``'`) Mark a term or section for inclusion in the index. | source code

label(self, doc) | source code

`str`

get_latex_encoding(self) Returns: The LaTeX representation of the selected encoding. | source code

Class Variables | [hide private]

| PREAMBLE = ``[``'``\\documentclass{article}``'``,` `'``\\usepackage{alltt, p``...``
| HRULE = ``'``\\rule{\\textwidth}{0.5\\fboxrule}\n\n``'``
| SECTIONS = ``[``'``\\part{%s}``'``,` `'``\\chapter{%s}``'``,` `'``\\section{%s}``'``,` `'``\``...``
| STAR_SECTIONS = ``[``'``\\part*{%s}``'``,` `'``\\chapter*{%s}``'``,` `'``\\section*{``...``
Function List
| _FUNC_GROUP_HEADER = ``'``\n\\large{\\textbf{\\textit{%s}}}\n\n``'``
Variable List
| _VAR_GROUP_HEADER = ``'``\\multicolumn{2}{|l|}{\\textit{%s}}\\\\\n``'``
Docstring -> LaTeX Conversion
| _docstring_linker = `_LatexDocstringLinker()`
Helpers
| latex_encodings = ``{``'``utf-8``'``:` `'``utf8``'``}`` Map the Python encoding representation into mismatching LaTeX ones.

Instance Variables | [hide private]

| _encoding The Python representation of the encoding.
| class_list The list of ClassDocs for the documented classes.
| class_set The set of ClassDocs for the documented classes.

Method Details | [hide private]

### 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.

### num_files(self)

source code

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

### get_latex_encoding(self)

source code

Returns: `str`
  The LaTeX representation of the selected encoding.

Class Variable Details | [hide private]

### PREAMBLE

Value:

      ['\\documentclass{article}',
       '\\usepackage{alltt, parskip, fancyhdr, boxedminipage}',
       '\\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}',
       '\\usepackage{fullpage}',
       '\\usepackage[usenames]{color}',
       '\\setlength{\\headheight}{16pt}',
       '\\setlength{\\headsep}{24pt}',
       '\\setlength{\\topmargin}{-\\headsep}',
      ...

### 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}']

Instance Variable Details | [hide private]

### _encoding

The Python representation of the encoding. Update latex_encodings in case of mismatch between it and the `inputenc` LaTeX package.