pygments.lexers.markup.RstLexer

class documentation

class RstLexer(RegexLexer):

New in version 0.7.

Additional options accepted:

handlecodeblocks: Highlight the contents of .. sourcecode:: language, .. code:: language and .. code-block:: language directives with a lexer for the given language (default: True).

New in version 0.8.

Method	`__init__`	Undocumented
Method	`_handle_sourcecode`	Undocumented
Method	`analyse_text`	No summary
Class Variable	`aliases`	Undocumented
Class Variable	`closers`	Undocumented
Class Variable	`end_string_suffix`	Undocumented
Class Variable	`filenames`	Undocumented
Class Variable	`mimetypes`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`tokens`	Undocumented
Class Variable	`unicode_delimiters`	Undocumented
Instance Variable	`handlecodeblocks`	Undocumented

Inherited from RegexLexer:

Method get_tokens_unprocessed Split text into (tokentype, text) pairs.

Inherited from Lexer (via RegexLexer):

Method	`get_tokens`	Return an iterable of (tokentype, value) pairs generated from `text`. If `unfiltered` is set to `True`, the filtering mechanism is bypassed even if filters are defined.
Class Variable	`alias_filenames`	Undocumented
Method	`__repr__`	Undocumented
Method	`add_filter`	Add a new stream filter to this lexer.
Class Variable	`priority`	Undocumented
Instance Variable	`encoding`	Undocumented
Instance Variable	`ensurenl`	Undocumented
Instance Variable	`filters`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`stripall`	Undocumented
Instance Variable	`stripnl`	Undocumented
Instance Variable	`tabsize`	Undocumented

def __init__(self, **options):

overrides pygments.lexer.Lexer.__init__

Undocumented

def _handle_sourcecode(self, match):

Undocumented

def analyse_text(text):

overrides pygments.lexer.Lexer.analyse_text

Has to return a float between 0 and 1 that indicates if a lexer wants to highlight this text. Used by guess_lexer. If this method returns 0 it won't highlight it in any case, if it returns 1 highlighting with this lexer is guaranteed.

The LexerMeta metaclass automatically wraps this function so that it works like a static method (no self or cls parameter) and the return value is automatically converted to float. If the return value is an object that is boolean False it's the same as if the return values was 0.0.

aliases: list[str] =

overrides pygments.lexer.Lexer.aliases

Undocumented

closers: str =

Undocumented

end_string_suffix =

Undocumented

filenames: list[str] =

overrides pygments.lexer.Lexer.filenames

Undocumented

mimetypes: list[str] =

overrides pygments.lexer.Lexer.mimetypes

Undocumented

name: str =

overrides pygments.lexer.Lexer.name

Undocumented

tokens =

overrides pygments.lexer.RegexLexer.tokens

Undocumented

unicode_delimiters: str =

Undocumented

handlecodeblocks =

Undocumented