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]...
Function:
cli2.example_obj.Client.yourcmd()
Test command
Argument
Help
SOMEARG
Some arg documentation
Required: True
Type: int
[x=X]
Required: False
Default: None
[verbose|no-verbose]
Enable verbose mode
Required: False
Negates:
no-verbose
Type: bool
Default: False
[ARGS]...
Required: True
usage: Any un-named arguments, ie.:
something other
[foooo=FOO]
Required: False
Aliases:
foo
,f
,foooo
Type: 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]
Function:
cli2.example_obj.Client.get()
Run GET request
Exmple link to
Command
:test: foo: - bar
Argument
Help
ARG
Some argument
Required: True
[base_url=BASE_URL]
Required: False
Default: http://example.com
all at once with auto
cli2-example¶
-
¶cli2-example
blabla
cli2-example get¶
-
cli2-example get ARG [base_url=BASE_URL]
Function:
cli2.example_obj.Client.get()
Run GET request
Exmple link to
Command
:test: foo: - bar
Argument
Help
ARG
Some argument
Required: True
[base_url=BASE_URL]
Required: False
Default: http://example.com
cli2-example post¶
-
¶cli2-example post ARG [base_url=BASE_URL]
Function:
cli2.example_obj.Client.post()
Argument
Help
ARG
Required: 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]...
Function:
cli2.example_obj.Client.yourcmd()
Test command
Argument
Help
SOMEARG
Some arg documentation
Required: True
Type: int
[x=X]
Required: False
Default: None
[verbose|no-verbose]
Enable verbose mode
Required: False
Negates:
no-verbose
Type: bool
Default: False
[ARGS]...
Required: True
usage: Any un-named arguments, ie.:
something other
[foooo=FOO]
Required: False
Aliases:
foo
,f
,foooo
Type: 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 noarg¶
-
¶cli2-example noarg
Function:
cli2.example_obj.noarg()
oo
cli2-example nodoc¶
-
¶cli2-example nodoc
Function:
cli2.example_obj.nodoc()
cli2-example nested¶
-
¶cli2-example nested
Nested group
Sub-Command |
Help |
---|---|
|
Get help for a command or group |
Nested group 2 |
cli2-example nested nested¶
-
¶cli2-example nested nested
Nested group 2
Sub-Command |
Help |
---|---|
|
Get help for a command or group |
Nested group 3 |
cli2-example nested nested nested¶
-
¶cli2-example nested nested nested
Nested group 3
Sub-Command |
Help |
---|---|
|
Get help for a command or group |