Functions
generate_help_all
1
str
▼
Generate a full command tree reference in markdown.
generate_help_all
1
str
▼
def generate_help_all(cli: CLI) -> str
Parameters
| Name | Type | Description |
|---|---|---|
cli |
CLI |
Returns
str
_format_cmd_markdown
3
None
▼
Format a single command as markdown.
_format_cmd_markdown
3
None
▼
def _format_cmd_markdown(cmd: CommandDef | LazyCommandDef, lines: list[str], prefix: str = '') -> None
Parameters
| Name | Type | Description |
|---|---|---|
cmd |
CommandDef | LazyCommandDef |
|
lines |
list[str] |
|
prefix |
str |
Default:''
|
_format_group_markdown
3
None
▼
Format a group and its commands as markdown.
_format_group_markdown
3
None
▼
def _format_group_markdown(group: Group, lines: list[str], depth: int) -> None
Parameters
| Name | Type | Description |
|---|---|---|
group |
Group |
|
lines |
list[str] |
|
depth |
int |