markdown.extensions.toc.TocTreeprocessor

class documentation

class TocTreeprocessor(Treeprocessor): (source)

Undocumented

Method	`__init__`	Undocumented
Method	`add_anchor`	Undocumented
Method	`add_permalink`	Undocumented
Method	`build_toc_div`	Return a string div given a toc list.
Method	`iterparent`	Iterator wrapper to get allowed parent and child all at once.
Method	`replace_marker`	Replace marker with elem.
Method	`run`	Subclasses of Treeprocessor should implement a `run` method, which takes a root ElementTree. This method can return another ElementTree object, and the existing root ElementTree will be replaced, or it can modify the current tree and return None.
Method	`set_level`	Adjust header level according to base level.
Instance Variable	`anchorlink_class`	Undocumented
Instance Variable	`base_level`	Undocumented
Instance Variable	`header_rgx`	Undocumented
Instance Variable	`marker`	Undocumented
Instance Variable	`permalink_class`	Undocumented
Instance Variable	`permalink_title`	Undocumented
Instance Variable	`sep`	Undocumented
Instance Variable	`slugify`	Undocumented
Instance Variable	`title`	Undocumented
Instance Variable	`toc_bottom`	Undocumented
Instance Variable	`toc_class`	Undocumented
Instance Variable	`toc_top`	Undocumented
Instance Variable	`use_anchors`	Undocumented
Instance Variable	`use_permalinks`	Undocumented

Inherited from Processor (via Treeprocessor):

Instance Variable md Undocumented

def __init__(self, md, config): (source)

overrides markdown.util.Processor.__init__

Undocumented

def add_anchor(self, c, elem_id): (source)

Undocumented

def add_permalink(self, c, elem_id): (source)

Undocumented

def build_toc_div(self, toc_list): (source)

Return a string div given a toc list.

def iterparent(self, node): (source)

Iterator wrapper to get allowed parent and child all at once.

def replace_marker(self, root, elem): (source)

Replace marker with elem.

def run(self, doc): (source)

overrides markdown.treeprocessors.Treeprocessor.run

Subclasses of Treeprocessor should implement a `run` method, which takes a root ElementTree. This method can return another ElementTree object, and the existing root ElementTree will be replaced, or it can modify the current tree and return None.

def set_level(self, elem): (source)

Adjust header level according to base level.

anchorlink_class = (source)

Undocumented

base_level = (source)

Undocumented

header_rgx = (source)

Undocumented

marker = (source)

Undocumented

permalink_class = (source)

Undocumented