diff options
| author | 2024-01-25 17:46:34 +0800 | |
|---|---|---|
| committer | 2024-01-25 17:46:34 +0800 | |
| commit | c4eb3ae7a74c7c6881540d7d04502600197a8b2a (patch) | |
| tree | c920c29c383da4d496a0f646e5d4d0f5de10a406 /docs/CLI/index.md | |
| parent | 3c3e121bc845573a2d2408c0db6be6f841fd8efc (diff) | |
| download | infini-c4eb3ae7a74c7c6881540d7d04502600197a8b2a.tar.gz infini-c4eb3ae7a74c7c6881540d7d04502600197a8b2a.zip | |
:fire: feat(docs): remove old documents
Diffstat (limited to 'docs/CLI/index.md')
| -rw-r--r-- | docs/CLI/index.md | 66 |
1 files changed, 0 insertions, 66 deletions
diff --git a/docs/CLI/index.md b/docs/CLI/index.md deleted file mode 100644 index cef69104..00000000 --- a/docs/CLI/index.md +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: CLI Reference ---- - -```python exec="1" idprefix="" -import argparse -import re -from infini import Cli - -parser = Cli().parser - -MONOSPACED = ("pyproject.toml", "pdm.lock", ".pdm-python", ":pre", ":post", ":all") - -def clean_help(help: str) -> str: - # Make dunders monospaced avoiding italic markdown rendering - help = re.sub(r"__([\w\d\_]+)__", r"`__\1__`", help) - # Make env vars monospaced - help = re.sub(r"env var: ([A-Z_]+)", r"env var: `\1`", help) - for monospaced in MONOSPACED: - help = re.sub(rf"\s(['\"]?{monospaced}['\"]?)", f"`{monospaced}`", help) - return help - - -def render_parser( - parser: argparse.ArgumentParser, title: str, heading_level: int = 2 -) -> str: - """Render the parser help documents as a string.""" - result = [f"{'#' * heading_level} {title}\n"] - if parser.description and title != "infini": - result.append("> " + parser.description + "\n") - - for group in sorted( - parser._action_groups, key=lambda g: g.title.lower(), reverse=True - ): - if not any( - bool(action.option_strings or action.dest) - or isinstance(action, argparse._SubParsersAction) - for action in group._group_actions - ): - continue - - result.append(f"{group.title.title()}:\n") - for action in group._group_actions: - if isinstance(action, argparse._SubParsersAction): - for name, subparser in action._name_parser_map.items(): - result.append(render_parser(subparser, name, heading_level + 1)) - continue - - opts = [f"`{opt}`" for opt in action.option_strings] - if not opts: - line = f"- `{action.dest}`" - else: - line = f"- {', '.join(opts)}" - if action.metavar: - line += f" `{action.metavar}`" - line += f": {clean_help(action.help)}" - if action.default and action.default != argparse.SUPPRESS: - line += f" (default: `{action.default}`)" - result.append(line) - result.append("") - - return "\n".join(result) - - -print(render_parser(parser, "infini")) -```
\ No newline at end of file |
