Skip to content

cli ¤

Module that contains the command line application.

Modules:

  • debug –

    Debugging utilities.

Functions:

  • get_parser –

    Return the CLI argument parser.

  • main –

    Run the main program.

get_parser ¤

get_parser() -> ArgumentParser

Return the CLI argument parser.

Returns:

main ¤

main(args: list[str] | None = None) -> int

Run the main program.

This function is executed when you type griffe-docfx or python -m griffe_docfx.

Parameters:

  • args (list[str] | None, default: None ) –

    Arguments passed from the command line.

Returns:

  • int –

    An exit code.