sphinx-click#

Sphinx extension that automatically generates documentation from Click CLI applications.

Example#

greet#

A sample command group.

Usage

greet [OPTIONS] COMMAND [ARGS]...

hello#

Greet a user.

Usage

greet hello [OPTIONS] USER

Arguments

USER#

Required argument

Environment variables

USER

Provide a default for USER

world#

Greet the world.

Usage

greet world [OPTIONS]