mistletoe.contrib.jira_renderer.JIRARenderer

class documentation

class JIRARenderer(BaseRenderer): (source)

JIRA renderer class.

See mistletoe.base_renderer module for more info.

Static Method	`render_html_block`	Undocumented
Static Method	`render_html_span`	Undocumented
Static Method	`render_line_break`	Undocumented
Static Method	`render_thematic_break`	Undocumented
Method	`__init__`	No summary
Method	`render_auto_link`	Undocumented
Method	`render_block_code`	Undocumented
Method	`render_document`	Undocumented
Method	`render_emphasis`	Undocumented
Method	`render_escape_sequence`	Undocumented
Method	`render_heading`	Undocumented
Method	`render_image`	Undocumented
Method	`render_inline_code`	Undocumented
Method	`render_inner`	Recursively renders child tokens. Joins the rendered strings with no space in between.
Method	`render_link`	Undocumented
Method	`render_list`	Undocumented
Method	`render_list_item`	Undocumented
Method	`render_paragraph`	Undocumented
Method	`render_quote`	Undocumented
Method	`render_raw_text`	Default render method for RawText. Simply return token.content.
Method	`render_strikethrough`	Undocumented
Method	`render_strong`	Undocumented
Method	`render_table`	Undocumented
Method	`render_table_cell`	Undocumented
Method	`render_table_row`	Undocumented
Instance Variable	`lastChildOfQuotes`	Undocumented
Instance Variable	`listTokens`	Undocumented
Method	`_block_eol`	Jira syntax is very limited when it comes to lists: whenever we put an empty line anywhere in a list, it gets terminated and there seems to be no workaround for this. Also to have blocks like paragraphs really vertically separated, we need to put an empty line between them...

Inherited from BaseRenderer:

Method	`__enter__`	Make renderer classes into context managers.
Method	`__exit__`	Make renderer classes into context managers.
Method	`render`	Grabs the class name from input token and finds its corresponding render function.
Instance Variable	`footnotes`	Undocumented
Instance Variable	`render_map`	maps tokens to their corresponding render functions.
Class Method	`_cls_to_func`	Undocumented
Static Method	`_tokens_from_module`	Helper method; takes a module and returns a list of all token classes specified in module.__all__. Useful when custom tokens are defined in a separate module.
Class Variable	`_parse_name`	Undocumented
Instance Variable	`_extras`	a list of custom tokens to be added to the parsing process.

@staticmethod
def render_html_block(token): (source) ¶

Undocumented

@staticmethod
def render_html_span(token): (source) ¶

Undocumented

@staticmethod
def render_line_break(token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_line_break

Undocumented

@staticmethod
def render_thematic_break(token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_thematic_break

Undocumented

def __init__(self, *extras): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.__init__

Parameters
*extras:`list`	allows subclasses to add even more custom tokens.

def render_auto_link(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_auto_link

Undocumented

def render_block_code(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_block_code

Undocumented

def render_document(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_document

Undocumented

def render_emphasis(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_emphasis

Undocumented

def render_escape_sequence(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_escape_sequence

Undocumented

def render_heading(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_heading

Undocumented

def render_image(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_image

Undocumented

def render_inline_code(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_inline_code

Undocumented

def render_inner(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_inner

Recursively renders child tokens. Joins the rendered strings with no space in between.

If newlines / spaces are needed between tokens, add them in their respective templates, or override this function in the renderer subclass, so that whitespace won't seem to appear magically for anyone reading your program.

Parameters
token	a branch node who has children attribute.

def render_link(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_link

Undocumented

def render_list(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_list

Undocumented

def render_list_item(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_list_item

Undocumented

def render_paragraph(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_paragraph

Undocumented

def render_quote(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_quote

Undocumented

def render_raw_text(self, token, escape=True): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_raw_text

Default render method for RawText. Simply return token.content.

def render_strikethrough(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_strikethrough

Undocumented

def render_strong(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_strong

Undocumented

def render_table(self, token): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table

Undocumented

def render_table_cell(self, token, in_header=False): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table_cell

Undocumented

def render_table_row(self, token, is_header=False): (source) ¶

overrides mistletoe.base_renderer.BaseRenderer.render_table_row

Undocumented

lastChildOfQuotes: list = (source) ¶

Undocumented

listTokens: list = (source) ¶

Undocumented

def _block_eol(self, token): (source) ¶

Jira syntax is very limited when it comes to lists: whenever we put an empty line anywhere in a list, it gets terminated and there seems to be no workaround for this. Also to have blocks like paragraphs really vertically separated, we need to put an empty line between them. This function handles these two cases.