Skip to content

markdown_refdocs/markdown

admonitions_to_markdown()

Generate markdown-style admonitions

def admonitions_to_markdown(parsed: Dict[str, List[str]]) -> str:

Args

  • parsed (Dict[str, List[str]])

Returns

  • str

Examples

admonitions_to_markdown({'note': ['make a note of this']})

admonitions_to_markdown({'warning': ['this is important']})

function_to_markdown()

Generate a markdown string for a function definition

def function_to_markdown(
    parsed: ParsedFunction, heading_level: int = 2, types_links: Dict[str, str] = {}
) -> str:

Args

  • parsed (ParsedFunction)
  • heading_level (int)
  • types_links (Dict[str, str])

Returns

  • str