epydoc.latex

Package epydoc :: Module latex |
[show private | hide private]
[frames | no frames]

## Module epydoc.latex

Documentation to LaTeX converter. This module defines a single class, `LatexFormatter`, which translates the API documentation encoded in a `DocMap` into a set of LaTeX files.

Bug: If a longtable is generated with a single row that's larger than a page, then LaTeX is unable to generate the correct output. This should only be a problem if a variable or property has a very long description.

Classes
`LatexFormatter` | Documentation to LaTeX converter.
`_LatexDocstringLinker` |

Variable Summary
`str` | `_HRULE`: LaTeX code for a horizontal rule across the page
`str` | `_LATEX_HEADER`: The header for standard documentation LaTeX pages.
`list` | `_SECTIONS`: A list of string patterns that encode each numbered section level.
`list` | `_STARSECTIONS`: A list of string patterns that encode each un-numbered section level.

Variable Details

    ### _HRULE LaTeX code for a horizontal rule across the page Type: `str` Value:
        '''\\rule{\\textwidth}{0.5\\fboxrule}

        '''

    ### _LATEX_HEADER The header for standard documentation LaTeX pages. Type: `str` Value:
        '''\\documentclass{article}
        \\usepackage{alltt, parskip, fancyheadings, boxedminipage}
        \\usepackage{makeidx, multirow, longtable, tocbibind, amssymb}
        \\usepackage{fullpage}
        %\\usepackage[headings]{fullpage}
        \\begin{document}

        \\setlength{\\parindent}{0ex}
        ...

    ### _SECTIONS A list of string patterns that encode each numbered section level. Type: `list` Value:
        ['\\part{%s}',
         '\\chapter{%s}',
         '\\section{%s}',
         '\\subsection{%s}',
         '\\subsubsection{%s}',
         '\\textbf{%s}']

    ### _STARSECTIONS A list of string patterns that encode each un-numbered section level. Type: `list` Value:
        ['\\part*{%s}',
         '\\chapter*{%s}',
         '\\section*{%s}',
         '\\subsection*{%s}',
         '\\subsubsection*{%s}',
         '\\textbf{%s}']

Generated by Epydoc 2.1 on Sat Mar 20 17:46:12 2004 | http://epydoc.sf.net