Sphinx-Docs extension¶
Link to group cli2-example
Link to arg cli2-example get base_url
Link to a command cli2-example get or cli2-example yourcmd
foo
-
cli2-example yourcmd SOMEARG [x=X] [verbose|no-verbose] [ARGS]… [foooo=FOO] [base_url=BASE_URL] [KWARGS=VALUE]…
¶ -
SOMEARG
- description:
Some arg documentation
- type:
int
-
[x=X]
- default:
None
-
[verbose|no-verbose]
- description:
Enable verbose mode
- negates:
no-verbose- type:
bool
- default:
False
-
[ARGS]...
- usage:
Any number of un-named arguments
-
[foooo=FOO]
- alias:
foo,f,foooo- type:
str
- default:
None
-
[base_url=BASE_URL]
- default:
-
[KWARGS=VALUE]...
- usage:
Any number of named arguments, example: something=somevalue
Test command
ARGUMENTS
blabla
-
cli2-example get ARG [base_url=BASE_URL]
¶ -
ARG
- description:
Some argument
-
[base_url=BASE_URL]
- default:
Run GET request
Exmple link to Command:
test:
foo:
- bar
ARGUMENTS
all at once with auto
cli2-example¶
- cli2-example¶
SUB-COMMANDS
help
Get help for a command or group
get
Run GET request Exmple link to Command: .
yourcmd
Test command
nested
Nested group
cli2-example get¶
-
cli2-example get ARG [base_url=BASE_URL]
-
ARG
- description:
Some argument
-
[base_url=BASE_URL]
- default:
Run GET request
Exmple link to Command:
test:
foo:
- bar
ARGUMENTS
cli2-example post¶
cli2-example yourcmd¶
-
cli2-example yourcmd SOMEARG [x=X] [verbose|no-verbose] [ARGS]… [foooo=FOO] [base_url=BASE_URL] [KWARGS=VALUE]…
-
SOMEARG
- description:
Some arg documentation
- type:
int
-
[x=X]
- default:
None
-
[verbose|no-verbose]
- description:
Enable verbose mode
- negates:
no-verbose- type:
bool
- default:
False
-
[ARGS]...
- usage:
Any number of un-named arguments
-
[foooo=FOO]
- alias:
foo,f,foooo- type:
str
- default:
None
-
[base_url=BASE_URL]
- default:
-
[KWARGS=VALUE]...
- usage:
Any number of named arguments, example: something=somevalue
Test command
ARGUMENTS
cli2-example nested¶
- cli2-example nested¶
SUB-COMMANDS
help
Get help for a command or group
nested
Nested group 2
cli2-example nested nested¶
- cli2-example nested nested¶
SUB-COMMANDS
help
Get help for a command or group
nested
Nested group 3
cli2-example nested nested nested¶
- cli2-example nested nested nested¶
SUB-COMMANDS
help
Get help for a command or group