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]... Test command
Argument
Help
SOMEARGSome arg documentation
Required: True
Type: int
[x=X]Required: False
Default: None
[verbose|no-verbose]Enable verbose mode
Required: False
Negates:
no-verboseType: bool
Default: False
[ARGS]...Required: True
usage: Any un-named arguments, ie.:
something other
[foooo=FOO]Required: False
Aliases:
foo,f,fooooType: str
Default: None
[base_url=BASE_URL]Required: False
Default: http://example.com
[KWARGS=VALUE]...Required: True
Usage: Any number of named self.arguments, ie.:
something=somevalue other=foo
blabla
-
¶cli2-example get ARG [base_url=BASE_URL] Run GET request
Exmple link to
Command:test: foo: - bar
Argument
Help
ARGSome argument
Required: True
[base_url=BASE_URL]Required: False
Default: http://example.com
all at once with auto
cli2-example¶
- cli2-example¶
cli2-example get¶
-
cli2-example get ARG [base_url=BASE_URL] Run GET request
Exmple link to
Command:test: foo: - bar
Argument
Help
ARGSome argument
Required: True
[base_url=BASE_URL]Required: False
Default: http://example.com
cli2-example post¶
-
¶cli2-example post ARG [base_url=BASE_URL] Argument
Help
ARGRequired: True
[base_url=BASE_URL]Required: False
Default: http://example.com
cli2-example yourcmd¶
-
cli2-example yourcmd SOMEARG [x=X] [verbose|no-verbose] [ARGS]... [foooo=FOO] [base_url=BASE_URL] [KWARGS=VALUE]... Test command
Argument
Help
SOMEARGSome arg documentation
Required: True
Type: int
[x=X]Required: False
Default: None
[verbose|no-verbose]Enable verbose mode
Required: False
Negates:
no-verboseType: bool
Default: False
[ARGS]...Required: True
usage: Any un-named arguments, ie.:
something other
[foooo=FOO]Required: False
Aliases:
foo,f,fooooType: str
Default: None
[base_url=BASE_URL]Required: False
Default: http://example.com
[KWARGS=VALUE]...Required: True
Usage: Any number of named self.arguments, ie.:
something=somevalue other=foo
cli2-example nested¶
cli2-example nested nested¶
- cli2-example nested nested¶
Sub-Command |
Help |
|---|---|
|
Get help for a command or group |
Nested group 3 |
cli2-example nested nested nested¶
- cli2-example nested nested nested¶
Sub-Command |
Help |
|---|---|
|
Get help for a command or group |