Added cli docs
This commit is contained in:
35
docs/build/html/_sources/cli.generate.md.txt
vendored
Normal file
35
docs/build/html/_sources/cli.generate.md.txt
vendored
Normal file
@@ -0,0 +1,35 @@
|
||||
# cpl generate
|
||||
|
||||
## Contents
|
||||
|
||||
- [Description](#description)
|
||||
- [Arguments](#arguments)
|
||||
- [Schematics](#schematics)
|
||||
|
||||
Generate a file based on schematic.
|
||||
|
||||
cpl **generate** *<schematic>* *<name>* <br>
|
||||
cpl **g** *<schematic>* *<name>* <br>
|
||||
cpl **G** *<schematic>* *<name>*
|
||||
|
||||
## Description
|
||||
|
||||
Generates files based on a schematic.
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Value type |
|
||||
| ----------------- |:---------------------------------:|:-------------:|
|
||||
| ```<schematic>``` | The schematic to generate. | ```str``` |
|
||||
| ```<name>``` | The name of the generated file. | ```str``` |
|
||||
|
||||
## Schematics
|
||||
|
||||
| Schematic | Description | Arguments |
|
||||
| ----------------- |:-------------------:|:----------------:|
|
||||
| ```abc``` | Abstract base class | ```<name>```
|
||||
| ```class``` | Class | ```<name>```
|
||||
| ```enum``` | Enum class | ```<name>```
|
||||
| ```service``` | Service class | ```<name>```
|
||||
| ```settings``` | [Configmodel](cpl.configuration) | ```<name>```
|
||||
| ```thread``` | Thread class | ```<name>```
|
||||
Reference in New Issue
Block a user