sphinx.directives.code.LiteralIncludeReader

class documentation

class LiteralIncludeReader: (source)

View In Hierarchy

Undocumented

Method __init__ Undocumented
Method append_filter Undocumented
Method dedent_filter Undocumented
Method end_filter Undocumented
Method lines_filter Undocumented
Method parse_options Undocumented
Method prepend_filter Undocumented
Method pyobject_filter Undocumented
Method read Undocumented
Method read_file Undocumented
Method show_diff Undocumented
Method start_filter Undocumented
Constant INVALID_OPTIONS_PAIR Undocumented
Instance Variable encoding Undocumented
Instance Variable filename Undocumented
Instance Variable lineno_start Undocumented
Instance Variable options Undocumented
def __init__(self, filename, options, config): (source)

Undocumented

Parameters
filename:strUndocumented
options:dict[str, Any]Undocumented
config:ConfigUndocumented
def append_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def dedent_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def end_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def lines_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def parse_options(self): (source)

Undocumented

def prepend_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def pyobject_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def read(self, location=None): (source)

Undocumented

Parameters
location:tuple[str, int]|NoneUndocumented
Returns
tuple[str, int]Undocumented
def read_file(self, filename, location=None): (source)

Undocumented

Parameters
filename:strUndocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def show_diff(self, location=None): (source)

Undocumented

Parameters
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
def start_filter(self, lines, location=None): (source)

Undocumented

Parameters
lines:list[str]Undocumented
location:tuple[str, int]|NoneUndocumented
Returns
list[str]Undocumented
INVALID_OPTIONS_PAIR: list = (source)

Undocumented

Value
[('lineno-match', 'lineno-start'),
 ('lineno-match', 'append'),
 ('lineno-match', 'prepend'),
 ('start-after', 'start-at'),
 ('end-before', 'end-at'),
 ('diff', 'pyobject'),
 ('diff', 'lineno-start'),
...
encoding = (source)

Undocumented

filename = (source)

Undocumented

lineno_start = (source)

Undocumented

options = (source)

Undocumented