httk.core.docs.cli

The httk docs command-line adapter over the documentation library.

Functions

build_parser(program)	Build the httk docs parser.
command(argv, context)	Handle the registered top-level docs command.

Module Contents

httk.core.docs.cli.build_parser(program)

Build the httk docs parser.

Parameters:

program (str) – Program name displayed by the parser.

Returns:

Configured command-line parser.

Return type:

argparse.ArgumentParser

httk.core.docs.cli.command(argv, context)

Handle the registered top-level docs command.

Parameters:

• argv (collections.abc.Sequence[str]) – Command-line arguments after the docs subcommand.

• context (httk.core.cli.CLIContext) – CLI execution context supplied by the top-level command runner.

Returns:

Process-style exit status.

Return type:

int