Markdown

Auto-generated documentation for mypy_boto3_builder.utils.markdown module.

Utils for markdown rendering.

• mypy-boto3-builder / Modules / Mypy Boto3 Builder / Utils / Markdown
  • Header
    • Header().anchor
    • Header().render
  • TableOfContents
    • TableOfContents.parse
    • TableOfContents().render
  • fix_pypi_headers

Header

[find in source code]

class Header():
    def __init__(title: str, level: int) -> None:

Markdown header.

Arguments

• title - Header title
• level - Header level, 1-6

Header().anchor

[find in source code]

@property
def anchor() -> str:

Anchor link for title.

Header().render

[find in source code]

def render() -> str:

Render menu item to string.

TableOfContents

[find in source code]

class TableOfContents():
    def __init__(headers: Iterable[Header]) -> None:

MarkDown Table of Contents.

Arguments

• headers - List of headers

See also

• Header

TableOfContents.parse

[find in source code]

@classmethod
def parse(text: str) -> _R:

Parse table of Contents for MarkDown text.

Arguments

• text - MarkDown text.

TableOfContents().render

[find in source code]

def render(max_level: int = 3) -> str:

Render ToC to string.

fix_pypi_headers

[find in source code]

def fix_pypi_headers(text: str) -> str:

Parse table of Contents for MarkDown text.

Arguments

• text - MarkDown text.