sphinx.directives.code.LiteralIncludeReader

class documentation

class LiteralIncludeReader:

View In Hierarchy

Undocumented

Constant INVALID​_OPTIONS​_PAIR 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
Instance Variable encoding Undocumented
Instance Variable filename Undocumented
Instance Variable lineno​_start Undocumented
Instance Variable options Undocumented
INVALID_OPTIONS_PAIR: list =

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'),
...
def __init__(self, filename, options, config):

Undocumented

Parameters
filename:strUndocumented
options:DictUndocumented
config:ConfigUndocumented
def append_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def dedent_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def end_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def lines_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def parse_options(self):

Undocumented

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

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def pyobject_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def read(self, location=None):

Undocumented

Parameters
location:Tuple[str, int]Undocumented
Returns
Tuple[str, int]Undocumented
def read_file(self, filename, location=None):

Undocumented

Parameters
filename:strUndocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def show_diff(self, location=None):

Undocumented

Parameters
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
def start_filter(self, lines, location=None):

Undocumented

Parameters
lines:List[str]Undocumented
location:Tuple[str, int]Undocumented
Returns
List[str]Undocumented
encoding =

Undocumented

filename =

Undocumented

lineno_start =

Undocumented

options =

Undocumented