sphinx.highlighting.PygmentsBridge

Modules Classes Names

class documentation

class PygmentsBridge: (source)

View In Hierarchy

Undocumented

Method	`__init__`	Undocumented
Method	`get_formatter`	Undocumented
Method	`get_lexer`	Undocumented
Method	`get_style`	Undocumented
Method	`get_stylesheet`	Undocumented
Method	`highlight_block`	Undocumented
Instance Variable	`dest`	Undocumented
Instance Variable	`formatter`	Undocumented
Instance Variable	`formatter_args`	Undocumented
Instance Variable	`latex_engine`	Undocumented

def __init__(self, dest='html', stylename='sphinx', latex_engine=None): (source) ¶

Undocumented

Parameters
dest:`str`	Undocumented
stylename:`str`	Undocumented
latex_engine:`str\|None`	Undocumented

def get_formatter(self, **kwargs): (source) ¶

Undocumented

Parameters
**kwargs:`Any`	Undocumented
Returns
`Formatter`	Undocumented

def get_lexer(self, source, lang, opts=None, force=False, location=None): (source) ¶

Undocumented

Parameters
source:`str`	Undocumented
lang:`str`	Undocumented
opts:`dict\|None`	Undocumented
force:`bool`	Undocumented
location:`Any`	Undocumented
Returns
`Lexer`	Undocumented

def get_style(self, stylename): (source) ¶

Undocumented

Parameters
stylename:`str`	Undocumented
Returns
`Style`	Undocumented

def get_stylesheet(self): (source) ¶

Undocumented

Returns
`str`	Undocumented

def highlight_block(self, source, lang, opts=None, force=False, location=None, **kwargs): (source) ¶

Undocumented

Parameters
source:`str`	Undocumented
lang:`str`	Undocumented
opts:`dict\|None`	Undocumented
force:`bool`	Undocumented
location:`Any`	Undocumented
**kwargs:`Any`	Undocumented
Returns
`str`	Undocumented

dest = (source) ¶

Undocumented

formatter = (source) ¶

Undocumented

formatter_args: dict[str, Any] = (source) ¶

Undocumented

latex_engine = (source) ¶

Undocumented