Skip to content

Cli

Command-line entry point for click-docs.

FUNCTION DESCRIPTION
cli

Generate Markdown documentation for a Click application.

Classes

Functions

cli

cli(ctx: Context, module_path: str, command_name: str, program_name: str | None, header_depth: int, style: str, output: str | None, depth: int | None, exclude: tuple[str, ...], show_hidden: bool, list_subcommands: bool, remove_ascii_art: bool, full_command_path: bool) -> None

Generate Markdown documentation for a Click application.

MODULE_PATH is a file system path to the Python module containing the Click command.