kr.motd.maven.sphinx.dist.pygments.formatters.html.py Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sphinx-maven-plugin Show documentation

Maven plugin that creates the site with Sphinx

There is a newer version: 2.10.0

# -*- coding: utf-8 -*-
"""
    pygments.formatters.html
    ~~~~~~~~~~~~~~~~~~~~~~~~

    Formatter for HTML output.

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

from __future__ import print_function

import os
import sys
import os.path

from pygments.formatter import Formatter
from pygments.token import Token, Text, STANDARD_TYPES
from pygments.util import get_bool_opt, get_int_opt, get_list_opt, \
    StringIO, string_types, iteritems

try:
    import ctags
except ImportError:
    ctags = None

__all__ = ['HtmlFormatter']


_escape_html_table = {
    ord('&'): u'&',
    ord('<'): u'<',
    ord('>'): u'>',
    ord('"'): u'"',
    ord("'"): u''',
}


def escape_html(text, table=_escape_html_table):
    """Escape &, <, > as well as single and double quotes for HTML."""
    return text.translate(table)


def _get_ttype_class(ttype):
    fname = STANDARD_TYPES.get(ttype)
    if fname:
        return fname
    aname = ''
    while fname is None:
        aname = '-' + ttype[-1] + aname
        ttype = ttype.parent
        fname = STANDARD_TYPES.get(ttype)
    return fname + aname


CSSFILE_TEMPLATE = '''\
td.linenos { background-color: #f0f0f0; padding-right: 10px; }
span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
pre { line-height: 125%%; }
%(styledefs)s
'''

DOC_HEADER = '''\




  %(title)s
  
  


%(title)s

'''

DOC_HEADER_EXTERNALCSS = '''\




  %(title)s
  
  


%(title)s

'''

DOC_FOOTER = '''\


'''


class HtmlFormatter(Formatter):
    r"""
    Format tokens as HTML 4 ```` tags within a ```` tag, wrapped
    in a ```` tag. The ````'s CSS class can be set by the `cssclass`
    option.

    If the `linenos` option is set to ``"table"``, the ```` is
    additionally wrapped inside a ```` which has one row and two
    cells: one containing the line numbers and one containing the code.
    Example:

    .. sourcecode:: html

        
        

          
            1
            2
          
          
            def foo(bar):
              pass
            
          
        

    (whitespace added to improve clarity).

    Wrapping can be disabled using the `nowrap` option.

    A list of lines can be specified using the `hl_lines` option to make these
    lines highlighted (as of Pygments 0.11).

    With the `full` option, a complete HTML 4 document is output, including
    the style definitions inside a ``