generate_cli_reference.py File Reference

Go to the source code of this file.

Namespaces
namespace	generate_cli_reference

Functions
	generate_cli_reference.build_parser ()
	Build the real parser, including registrars delegated from other modules.
str	generate_cli_reference.escape (text)
	Escape text for generated HTML.
dict	generate_cli_reference.describe_action (action)
	Capture the user-relevant contract of one argparse action.
str	generate_cli_reference._normalize_group_title (title)
	Resolve one argparse group title to a Python-version-independent form.
dict	generate_cli_reference.subcommands (parser)
	The subparser map of a parser, if it has one.
dict	generate_cli_reference.describe_parser (str name, parser)
	Recursively capture a command and its subcommands.
dict	generate_cli_reference.snapshot ()
	The full normalized parser snapshot.
list	generate_cli_reference.render_command (dict command, int depth=0, str prefix="")
	Render one command and its subcommands as HTML.
str	generate_cli_reference.render (dict data)
	Render the whole reference as an includable HTML fragment.
int	generate_cli_reference.main ()
	Write or verify the generated CLI reference.

Variables
	generate_cli_reference.REPO_ROOT = Path(__file__).resolve().parents[2]
str	generate_cli_reference.GENERATED_DIR = REPO_ROOT / "docs" / "generated"
str	generate_cli_reference.HTML_PATH = GENERATED_DIR / "cli_reference.html"
str	generate_cli_reference.JSON_PATH = GENERATED_DIR / "cli_reference.json"
dict	generate_cli_reference._MACHINE_DEPENDENT_DEFAULTS = {"workers": "<local CPU count, capped 1-8>"}
	generate_cli_reference._DEFAULT_GROUP_TITLE_SPELLINGS = frozenset({"optional arguments", "options"})
str	generate_cli_reference._CANONICAL_DEFAULT_GROUP_TITLE = "options"