Markdown

mypy-boto3-builder Index / Mypy Boto3 Builder / Utils / Markdown

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

Show source in markdown.py:12

Markdown header.

Arguments

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

Signature

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

Header().anchor

Show source in markdown.py:25

Anchor link for title.

Signature

@property
def anchor(self) -> str:
    ...

Header().render

Show source in markdown.py:32

Render menu item to string.

Signature

def render(self) -> str:
    ...

TableOfContents

Show source in markdown.py:40

MarkDown Table of Contents.

Arguments

  • headers - List of headers

Signature

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

See also

TableOfContents.parse

Show source in markdown.py:51

Parse table of Contents for MarkDown text.

Arguments

  • text - MarkDown text.

Signature

@classmethod
def parse(cls: type[_R], text: str) -> _R:
    ...

TableOfContents().render

Show source in markdown.py:74

Render ToC to string.

Signature

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

fix_pypi_headers

Show source in markdown.py:86

Parse table of Contents for MarkDown text.

Arguments

  • text - MarkDown text.

Signature

def fix_pypi_headers(text: str) -> str:
    ...