Overview

This reference is generated from the source docstrings. It is grouped by API area, mirroring the exported names in docopt2.__all__.

• docopt & results - the docopt entry point, the Arguments mapping, the Source provenance enum, the inverse format_argv, and parse_tree.
• Cli base class - the class-first Cli.parse(...) API.
• Subcommand dispatch - Dispatch, routing a matched command path to a handler.
• Schema stubs - generate_stub, codegen for a typed schema.
• Usage linting - check, the static usage-grammar linter.
• Formatting usage - format_usage, aligning and tidying the Options: block.
• Compatibility checking - check_compat, reporting breaking changes between two usages.
• Example generation - generate_examples, sampling accepted argument vectors.
• Config templates - generate_config_template, scaffolding a TOML config file.
• Shell completion - complete and generate_completion.
• Exceptions - DocoptExit and DocoptLanguageError.
• Usage grammar - the pattern node classes and the low-level parser primitives, exported for tools that reach into the parse tree.

For a task-oriented view, start from the Guides instead.