generated from jCloud/repository-template
chore: update API reference
This commit is contained in:
1 parent
cd35457301
commit
eabde41cec
14 files changed
+386
-57
No files matched your search
@@ -0,0 +1,107 @@
|
||||
# Module `jcloud_docsgen.cli.cli`
|
||||
|
||||
The command line interface
|
||||
|
||||
## Function `existing_directory`
|
||||
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
existing_directory(path: str) -> pathlib.Path
|
||||
```
|
||||
|
||||
### Returns
|
||||
|
||||
Return type: `pathlib.Path`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Kind | Default value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `path` | `str` | normal | -- | -- |
|
||||
|
||||
## Function `error`
|
||||
|
||||
Shows an error message and returns the exit code.
|
||||
|
||||
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
error(message: str, exit_code: int = 1)
|
||||
```
|
||||
|
||||
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Kind | Default value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `message` | `str` | normal | -- | The error message to show. |
|
||||
| `exit_code` | `int` | normal | `1` | The exit code. |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Docstring
|
||||
|
||||
Shows an error message and returns the exit code.
|
||||
|
||||
:param message: The error message to show.
|
||||
:type message: str
|
||||
:param exit_code: The exit code.
|
||||
:type exit_code: int
|
||||
|
||||
## Function `create_argument_parser`
|
||||
|
||||
Prepares a parser to parse the command-line arguments using
|
||||
argparse.
|
||||
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
create_argument_parser() -> argparse.ArgumentParser
|
||||
```
|
||||
|
||||
### Returns
|
||||
|
||||
The parser.
|
||||
|
||||
Return type: `argparse.ArgumentParser`
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Docstring
|
||||
|
||||
Prepares a parser to parse the command-line arguments using
|
||||
argparse.
|
||||
|
||||
:return: The parser.
|
||||
:rtype: argparse.ArgumentParser
|
||||
|
||||
## Function `main`
|
||||
|
||||
### Function signature
|
||||
|
||||
```python
|
||||
main(argv=None) -> int
|
||||
```
|
||||
|
||||
### Returns
|
||||
|
||||
Return type: `int`
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Kind | Default value | Description |
|
||||
| --- | --- | --- | --- | --- |
|
||||
| `argv` | -- | normal | `None` | -- |
|
||||
Reference in new issue
Block a user