app ¤

Definition of the Textual app application.

Classes:

GriffeMarkdownViewer –

A Markdown viewer with custom logic for links.
GriffeTUIApp –

A Textual app to visualize docs collected by Griffe.

GriffeMarkdownViewer ¤

GriffeMarkdownViewer(
    markdown: str | None = None,
    *,
    show_table_of_contents: bool = True,
    name: str | None = None,
    id: str | None = None,
    classes: str | None = None,
    parser_factory: Callable[[], MarkdownIt] | None = None,
    griffe_loader: GriffeLoader
)

Bases: MarkdownViewer

A Markdown viewer with custom logic for links.

GriffeTUIApp ¤

GriffeTUIApp(
    driver_class: type[Driver] | None = None,
    css_path: CSSPathType | None = None,
    watch_css: bool = False,
    *,
    griffe_loader: GriffeLoader | None = None
)

Bases: App

A Textual app to visualize docs collected by Griffe.

Methods:

action_toggle_dark –

An action to toggle dark mode.
compose –

Create child widgets for the app.
update_view –

Update Mardown view.

action_toggle_dark ¤

action_toggle_dark() -> None

An action to toggle dark mode.

compose ¤

compose() -> ComposeResult

Create child widgets for the app.

update_view ¤

update_view(event: Submitted) -> None

Update Mardown view.