pygments.formatters.latex

Formatter for LaTeX fancyvrb output.

copyright:Copyright 2006-2013 by the Pygments team, see AUTHORS. license:BSD, see LICENSE for details.

class pygments.formatters.latex.LatexFormatter(**options)

Format tokens as LaTeX code. This needs the fancyvrb and color standard packages.

Without the full option, code is formatted as one Verbatim environment, like this:

\begin{Verbatim}[commandchars=\\{\}]
\PY{k}{def }\PY{n+nf}{foo}(\PY{n}{bar}):
    \PY{k}{pass}
\end{Verbatim}

The special command used here (\PY) and all the other macros it needs are output by the get_style_defs method.

With the full option, a complete LaTeX document is output, including the command definitions in the preamble.

The get_style_defs() method of a LatexFormatter returns a string containing \def commands defining the macros needed inside the Verbatim environments.

Additional options accepted:

style

The style to use, can be a string or a Style subclass (default: 'default').

full

Tells the formatter to output a “full” document, i.e. a complete self-contained document (default: False).

title

If full is true, the title that should be used to caption the document (default: '').

docclass

If the full option is enabled, this is the document class to use (default: 'article').

preamble

If the full option is enabled, this can be further preamble commands, e.g. \usepackage (default: '').

linenos

If set to True, output line numbers (default: False).

linenostart

The line number for the first line (default: 1).

linenostep

If set to a number n > 1, only every nth line number is printed.

verboptions

Additional options given to the Verbatim environment (see the fancyvrb docs for possible values) (default: '').

commandprefix

The LaTeX commands used to produce colored output are constructed using this prefix and some letters (default: 'PY'). New in Pygments 0.7.

New in Pygments 0.10: the default is now 'PY' instead of 'C'.

texcomments

If set to True, enables LaTeX comment lines. That is, LaTex markup in comment tokens is not escaped so that LaTeX can render it (default: False). New in Pygments 1.2.

mathescape

If set to True, enables LaTeX math mode escape in comments. That is, '$...$' inside a comment will trigger math mode (default: False). New in Pygments 1.2.

get_style_defs(arg='')

Return the command sequences needed to define the commands used to format text in the verbatim environment. arg is ignored.