docs

Generate Markdown docs for a Typer app.

def docs(
    ctx: typer.Context,
    name: str = "",
    output: Path | None = None,
    title: str | None = None
) - > None

Generate Markdown docs for a Typer app.

Parameters

Name	Type	Description
ctx	typer.Context	The Typer context object used to manage state and access the underlying Click command structure.
name	str = ""	The name of the CLI program to be displayed within the generated documentation.
output	`Path	None` = None
title	`str	None` = None

Returns

Type	Description
None	Nothing is returned; the generated documentation is either printed to stdout or written to a file.